Add plop-dir support to override or extend inferred prompts

.changeset/kind-boxes-check.md

@@ -0,0 +1,5 @@
+---
+'plop-dir': patch
+---
+
+Add support to override or extends inferred prompts

packages/plop-dir/.eslintrc.js

@@ -8,5 +8,5 @@ module.exports = {
     tsconfigRootDir: __dirname,
     project: 'tsconfig.eslint.json',
   },
-  ignorePatterns: ['node_modules', 'dist'],
+  ignorePatterns: ['node_modules', 'dist', 'templates'],
 }

packages/plop-dir/README.md

@@ -42,6 +42,13 @@ export default async function run(plop) {
       templateDir: path.join(__dirname, './templates/my-generator'),
       // Path to output my-generator files
       outputDir: path.join(__dirname, './src'),
+      // Override or extend the inferred prompts
+      prompts: [
+        {
+          name: 'generatorName',
+          message: "What's the name of the generator?",
+        },
+      ],
     }),
   )
 }

packages/plop-dir/plopfile.mjs

@@ -17,6 +17,13 @@ export default async function run(plop) {
       templateDir: path.join(__dirname, './templates/my-generator'),
       // Path to output my-generator files
       outputDir: path.join(__dirname, './tmp'),
+      // Override or extend the inferred prompts
+      prompts: [
+        {
+          name: 'generatorName',
+          message: "What's the name of the generator?",
+        },
+      ],
     }),
   )
 }

packages/plop-dir/src/plop-dir.ts

@@ -4,20 +4,28 @@ import * as fs from 'node:fs'
 // @ts-expect-error
 import type { NodePlopAPI, PlopGeneratorConfig } from 'plop'
 
-interface PlopDirOptions {
+type PlopPromptQuestion = Extract<PlopGeneratorConfig['prompts'], any[]>[number]
+
+export const plopDirActionType = 'plop-dir'
+
+export interface PlopDirOptions {
   plop: NodePlopAPI
   templateDir: string
   outputDir: string
   description?: string
-  // TODO: Add support for overriding inferred prompts
+  prompts?: Partial<PlopPromptQuestion>[]
 }
 
-export const plopDirActionType = 'plop-dir'
-
 export async function plopDir(
   options: PlopDirOptions,
 ): Promise<PlopGeneratorConfig> {
-  const { plop, templateDir, outputDir, description = '' } = options
+  const {
+    plop,
+    templateDir,
+    outputDir,
+    description = '',
+    prompts = [],
+  } = options
 
   const templateFiles = await getTemplateFiles(templateDir)
 
@@ -69,6 +77,7 @@ export async function plopDir(
       type: 'input',
       name: promptName,
       message: `Enter ${promptName}`,
+      ...prompts.find((prompt) => prompt.name === promptName),
     })),
     actions: [{ type: plopDirActionType }],
   }

packages/plop-dir/templates/my-generator/{{kebabCase generatorName}}/tests/{{kebabCase generatorName}}.input.scss

@@ -0,0 +1,3 @@
+export default function {{camelCase generatorName}}() {
+	return '{{pascalCase generatorName}}';
+}

packages/plop-dir/templates/my-generator/{{kebabCase generatorName}}/tests/{{kebabCase generatorName}}.output.scss

@@ -0,0 +1,3 @@
+export default function {{camelCase generatorName}}() {
+	return '{{pascalCase generatorName}}';
+}

packages/plop-dir/templates/my-generator/{{kebabCase generatorName}}/{{kebabCase generatorName}}.ts

@@ -0,0 +1,3 @@
+export default function {{camelCase generatorName}}() {
+	return '{{pascalCase generatorName}}';
+}

packages/plop-dir/tsconfig.json

@@ -4,6 +4,6 @@
     "outDir": "dist",
     "declarationDir": "dist/types"
   },
-  "include": ["src", "scripts"],
+  "include": ["src"],
   "exclude": ["node_modules", "dist"]
 }