Restructure plop-dir examples and align README documentation

aaronccasanova · Sep 18, 2022 · 11a3fc8 · 11a3fc8 · vercel · Sep 18, 2022
1 parent 9e2c8c5
commit 11a3fc8
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 17 deletions.
diff --git a/.changeset/cyan-books-fly.md b/.changeset/cyan-books-fly.md
@@ -0,0 +1,5 @@
+---
+'plop-dir': patch
+---
+
+Restructure examples and align README documentation
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/plop-dir/README.md b/packages/plop-dir/README.md
@@ -33,7 +33,7 @@ import { plopDir } from 'plop-dir'
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 /** @param {import('plop').NodePlopAPI} plop */
-export default async function (plop) {
+export default async function run(plop) {
   plop.setGenerator(
     'my-generator',
     await plopDir({
@@ -47,7 +47,7 @@ export default async function (plop) {
 }
 ```
 
-> Note: Currently, `plopDir` is only supported in asynchronous `plopfile`s.
+> Note: Currently, `plopDir` is only supported in asynchronous `plopfile`s
 
 Example template directory:
 
@@ -78,7 +78,7 @@ export default function {{camelCase extractedPrompt}}() {
 Run the `plop` CLI:
 
 ```sh
-$ npx plop my-generator
+$ npm run plop my-generator
 Enter extractedPrompt: <answer>
 Enter anotherPrompt: <answer>
 ✔  plop-dir successfully wrote files to <outputDir>

diff --git a/packages/plop-dir/package.json b/packages/plop-dir/package.json
@@ -23,7 +23,7 @@
     "lint": "TIMING=1 eslint . --ext .js,.ts --cache",
     "test": "jest",
     "prepublishOnly": "npm run build",
-    "generate": "plop"
+    "plop": "plop"
   },
   "files": [
     "dist"

diff --git a/packages/plop-dir/plopfile.mjs b/packages/plop-dir/plopfile.mjs
@@ -1,24 +1,22 @@
 import * as url from 'node:url'
+import * as path from 'node:path'
 
 import { plopDir } from './dist/esm/index.mjs'
 
+// eslint-disable-next-line @typescript-eslint/naming-convention, no-underscore-dangle
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url))
+
 /** @param {import('plop').NodePlopAPI} plop */
 // eslint-disable-next-line import/no-default-export
-export default async function generate(plop) {
+export default async function run(plop) {
   plop.setGenerator(
-    'scss-migration',
+    'my-generator',
     await plopDir({
       plop,
-      templateDir: url.fileURLToPath(new URL('./templates', import.meta.url)),
-      outputDir: url.fileURLToPath(new URL('./src/nested', import.meta.url)),
+      // Path to my-generator templates
+      templateDir: path.join(__dirname, './templates/my-generator'),
+      // Path to output my-generator files
+      outputDir: path.join(__dirname, './tmp'),
     }),
   )
-
-  // plop.setGenerator(
-  //   'typescript-migration',
-  //   await plopDir(plop, {
-  //     templateDir: url.fileURLToPath(new URL('./templates', import.meta.url)),
-  //     outputDir: url.fileURLToPath(new URL('./src/nested', import.meta.url)),
-  //   }),
-  // )
 }
diff --git a/...tionName}}/tests/{{testName}}.test.ts.hbs → ...me}}/tests/{{camelCase testName}}.test.ts b/...tionName}}/tests/{{testName}}.test.ts.hbs → ...me}}/tests/{{camelCase testName}}.test.ts
diff --git a/...{kebabCase migrationName}}.input.scss.hbs → ...ts/{{kebabCase migrationName}}.input.scss b/...{kebabCase migrationName}}.input.scss.hbs → ...ts/{{kebabCase migrationName}}.input.scss
diff --git a/...kebabCase migrationName}}.output.scss.hbs → ...s/{{kebabCase migrationName}}.output.scss b/...kebabCase migrationName}}.output.scss.hbs → ...s/{{kebabCase migrationName}}.output.scss
diff --git a/...Name}}/{{kebabCase migrationName}}.ts.hbs → ...tionName}}/{{kebabCase migrationName}}.ts b/...Name}}/{{kebabCase migrationName}}.ts.hbs → ...tionName}}/{{kebabCase migrationName}}.ts