Merge pull request #94 from evoactivity/route-template

Support generating route templates

Author: bertdeblock

src/cli.ts

@@ -9,6 +9,7 @@ import { GemberError, logGemberErrors } from "./errors.js";
 import {
   generators,
   getGenerator,
+  getTemplateGenerator,
   getTestGenerator,
 } from "./generators/generators.js";
 import { readOwnPackageJsonSync } from "./internal.js";
@@ -135,6 +136,16 @@ function generatorCommands(deprecated?: boolean): SubCommandsDef {
               );
             }
           }
+
+          if (context.args.template) {
+            if (generator.args.find((arg) => arg.name === "template")) {
+              await getTemplateGenerator().run(context.args);
+            } else {
+              logger.warn(
+                `You passed the \`--template\` option, but the \`${generator.name}\` generator does not support generating a template.`,
+              );
+            }
+          }
         });
       },
     };

src/config.ts

@@ -159,6 +159,8 @@ export type Config = {
       log?: boolean;
       // Generate a route at a custom path, e.g. `--path=src/-private`:
       path?: string;
+      // Generate a corresponding template:
+      template?: boolean;
       // Generate a corresponding route-test:
       test?: boolean;
       // Generate a `.ts` route, instead of a `.js` route:
@@ -178,6 +180,22 @@ export type Config = {
       // Generate a `.ts` route-test, instead of a `.js` route-test:
       typescript?: boolean;
     };
+    template?: {
+      // Generate a `class-based` template, instead of a `template-only` template:
+      classBased?: boolean;
+      // Copy the generated template to the clipboard, instead of writing it to disk:
+      copy?: boolean;
+      // The current working directory to run the template generator in:
+      cwd?: string;
+      // Destroy a template by name:
+      destroy?: boolean;
+      // Log the generated template to the console, instead of writing it to disk:
+      log?: boolean;
+      // Generate a template at a custom path, e.g. `--path=src/-private`:
+      path?: string;
+      // Generate a `.gts` template, instead of a `.gjs` template:
+      typescript?: boolean;
+    };
     service?: {
       // Copy the generated service to the clipboard, instead of writing it to disk:
       copy?: boolean;

src/generators/generator.ts

@@ -358,6 +358,14 @@ export function path(): GeneratorArgFactory {
   });
 }
 
+export function template(): GeneratorArgFactory {
+  return () => ({
+    description: `Generate a corresponding template`,
+    name: "template",
+    type: "boolean",
+  });
+}
+
 export function test(): GeneratorArgFactory {
   return (generatorName) => ({
     description: `Generate a corresponding ${testGeneratorName(generatorName)}`,

src/generators/generators.ts

@@ -5,6 +5,7 @@ import {
   defineTestGenerator,
   namedExport,
   nested,
+  template,
   test,
   testGeneratorName,
   typescript,
@@ -73,7 +74,7 @@ export const generators: Generator[] = [
   }),
 
   defineGenerator({
-    args: [test(), typescript()],
+    args: [template(), test(), typescript()],
     name: "route",
   }),
 
@@ -94,6 +95,17 @@ export const generators: Generator[] = [
     testsDir: "unit",
   }),
 
+  defineGenerator({
+    args: [
+      classBased({ functionBasedName: "template-only" }),
+      typescript({ gts: true }),
+    ],
+    modifyTemplateFile: (templateFile) => {
+      templateFile.name = "component";
+    },
+    name: "template",
+  }),
+
   defineGenerator({
     args: [namedExport(), test(), typescript()],
     name: "util",
@@ -121,3 +133,7 @@ export function getGenerator(generatorName: string): Generator {
 export function getTestGenerator(generatorName: string): Generator {
   return getGenerator(testGeneratorName(generatorName));
 }
+
+export function getTemplateGenerator(): Generator {
+  return getGenerator("template");
+}

templates/template/component.class-based.gjs

@@ -0,0 +1,5 @@
+import Component from '@glimmer/component';
+
+export default class {{name.pascal}} extends Component {
+  <template>\{{yield}}</template>
+}

templates/template/component.class-based.gts

@@ -0,0 +1,18 @@
+import Component from '@glimmer/component';
+
+export interface {{name.signature}} {
+  Args: {
+    model: unknown;
+    controller: unknown;
+  };
+  Blocks: {
+    default: [];
+  };
+  Element: null;
+}
+
+export default class {{name.pascal}} extends Component<{{name.signature}}> {
+  <template>
+    \{{yield}}
+  </template>
+}

templates/template/component.template-only.gjs

@@ -0,0 +1 @@
+<template>\{{yield}}</template>

templates/template/component.template-only.gts

@@ -0,0 +1,16 @@
+import type { TOC } from '@ember/component/template-only';
+
+export interface {{name.signature}} {
+  Args: {
+    model: unknown;
+    controller: unknown;
+  };
+  Blocks: {
+    default: [];
+  };
+  Element: null;
+}
+
+const {{name.pascal}}: TOC<{{name.signature}}> = <template>\{{yield}}</template>;
+
+export default {{name.pascal}};