Merge pull request #80 from bertdeblock/support-running-generators-interactively

Support running generators interactively

Author: bertdeblock

README.md

@@ -47,6 +47,8 @@ yarn add -D @bertdeblock/gember
 
 ## Usage
 
+> 💡 Run `pnpm gember` to run generators interactively.
+
 > 💡 Run `pnpm gember --help` for all available generators.
 
 > 💡 Run `pnpm gember <generator-name> --help` for all available generator options.

src/cli.ts

@@ -9,8 +9,9 @@ import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 // eslint-disable-next-line n/no-missing-import
 import type { PackageJson } from "type-fest";
-import { logGemberErrors } from "./errors.js";
+import { GemberError, logGemberErrors } from "./errors.js";
 import { generators } from "./generators.js";
+import { logger } from "./logger.js";
 
 const { description, name, version }: PackageJson = readJsonSync(
   join(dirname(fileURLToPath(import.meta.url)), "..", "package.json"),
@@ -23,6 +24,62 @@ const main = defineCommand({
     version,
   },
 
+  run: (context): void => {
+    if (context.rawArgs.length > 0) {
+      return;
+    }
+
+    logGemberErrors(async () => {
+      // @ts-expect-error: The `multiselect` return type is incorrect:
+      const selectedGeneratorNames: string[] | undefined = await logger.prompt(
+        "Which generators would you like to run?",
+        {
+          options: generators.map((generator) => ({
+            hint: generator.description,
+            label: generator.name,
+            value: generator.name,
+          })),
+          type: "multiselect",
+        },
+      );
+
+      if (selectedGeneratorNames === undefined) {
+        // The user probably cancelled the interactive flow:
+        return;
+      }
+
+      let entityName: string | undefined;
+
+      for (const selectedGeneratorName of selectedGeneratorNames.sort()) {
+        const selectedGenerator = generators.find(
+          (generator) => generator.name === selectedGeneratorName,
+        );
+
+        if (selectedGenerator === undefined) {
+          throw new GemberError(
+            `[BUG] Could not find generator \`${selectedGeneratorName}\`.`,
+          );
+        }
+
+        entityName = await logger.prompt(
+          `Please provide a name for generator \`${selectedGenerator.name}\`:`,
+          {
+            initial: entityName,
+            type: "text",
+          },
+        );
+
+        if (entityName === undefined) {
+          throw new GemberError(
+            `A name must be provided for generator \`${selectedGenerator.name}\`.`,
+          );
+        }
+
+        await selectedGenerator.run({ name: entityName });
+      }
+    });
+  },
+
   subCommands: generators.reduce((subCommands: SubCommandsDef, generator) => {
     subCommands[generator.name] = {
       args: generator.args.reduce((args: ArgsDef, arg) => {

src/generator.ts

@@ -158,6 +158,8 @@ export function defineGenerator({
           { type: "confirm" },
         );
 
+        logger.log("");
+
         if (response === false) {
           return;
         }
@@ -211,7 +213,7 @@ export function defineTestGenerator(
   return defineGenerator({
     ...options,
     modifyTargetFile: (targetFile, args) => {
-      if (args.path === undefined) {
+      if (args.path === undefined && env.GEMBER_PATH === undefined) {
         targetFile.subDir = join(
           "tests",
           options.testsDir,