Initial work to migrate to ESM node-plop

package.json

@@ -52,7 +52,7 @@
     "interpret": "^2.2.0",
     "liftoff": "^4.0.0",
     "minimist": "^1.2.5",
-    "node-plop": "^0.26.3",
+    "node-plop": "^0.30.0-alpha.1",
     "ora": "^6.0.1",
     "v8flags": "^4.0.0"
   },

src/plop.js

@@ -41,19 +41,27 @@ const progressSpinner = ora({
  * One of the reasons we default generator arguments as anything past `--` is a few reasons:
  * Primarily that there may be name-spacing issues when combining the arg order and named arg passing
  */
-function run(env, _, passArgsBeforeDashes) {
+async function run(env, _, passArgsBeforeDashes) {
   const plopfilePath = env.configPath;
 
   // handle basic argument flags like --help, --version, etc
   handleArgFlags(env);
 
   // use base path from argv or env if any is present, otherwise set it to the plopfile directory
   const destBasePath = argv.dest || env.dest;
-  const plop = nodePlop(plopfilePath, {
-    destBasePath: destBasePath ? path.resolve(destBasePath) : undefined,
-    force: argv.force === true || argv.f === true || false,
-  });
-
+  let plop;
+  try {
+    plop = await nodePlop(plopfilePath, {
+      destBasePath: destBasePath ? path.resolve(destBasePath) : undefined,
+      force: argv.force === true || argv.f === true || false,
+    });
+  } catch (e) {
+    console.error(
+      chalk.red("[PLOP] ") + "Something went wrong with reading your plop file",
+      e
+    );
+    return;
+  }
   const generators = plop.getGeneratorList();
   const generatorNames = generators.map((v) => v.name);
   const { generatorName, bypassArr, plopArgV } = getBypassAndGenerator(

tests/examples/add-action/package.json

@@ -1,3 +1,7 @@
 {
-  "name": "plop-example-add-action"
+  "name": "plop-example-add-action",
+  "type": "module",
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  }
 }

tests/examples/add-action/plopfile.js

@@ -1,4 +1,4 @@
-module.exports = function (plop) {
+export default function (plop) {
   plop.setGenerator("addAndNameFile", {
     description: "Name that file",
     prompts: [
@@ -34,4 +34,4 @@ module.exports = function (plop) {
       },
     ],
   });
-};
+}

tests/examples/javascript/package.json

@@ -1,3 +1,7 @@
 {
-  "name": "plop-example"
+  "name": "plop-example",
+  "type": "module",
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  }
 }

tests/examples/javascript/plopfile.js

@@ -1,7 +1,7 @@
-"use strict";
-const path = require("path");
-
-module.exports = function (plop) {
+import path from "path";
+import fs from "fs";
+import inquirerDirectory from "inquirer-directory";
+export default function (plop) {
   // starting prompt can be customized to display what you want
   // plop.setWelcomeMessage('[CUSTOM]'.yellow + ' What can I do for you?');
 
@@ -99,7 +99,6 @@ module.exports = function (plop) {
         process.chdir(plop.getPlopfilePath());
 
         // custom function can be synchronous or async (by returning a promise)
-        var fs = require("fs");
         var existsMsg = "psst {{name}}, change-me.txt already exists";
         var copiedMsg = "hey {{name}}, I copied change-me.txt for you";
         var changeFileName = "change-me.txt";
@@ -160,7 +159,7 @@ module.exports = function (plop) {
   });
 
   // adding a custom inquirer prompt type
-  plop.addPrompt("directory", require("inquirer-directory"));
+  plop.addPrompt("directory", inquirerDirectory);
 
   plop.setGenerator("custom-prompt", {
     description: "custom inquirer prompt example",
@@ -247,4 +246,4 @@ module.exports = function (plop) {
       return actions;
     },
   });
-};
+}

tests/examples/prompt-only/package.json

@@ -1,3 +1,7 @@
 {
-  "name": "plop-example-prompts-only"
+  "name": "plop-example-prompts-only",
+  "type": "module",
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  }
 }

tests/examples/prompt-only/plopfile.js

@@ -1,4 +1,4 @@
-module.exports = function (plop) {
+export default function (plop) {
   plop.setGenerator("test", {
     description: "this is a test",
     prompts: [
@@ -27,4 +27,4 @@ module.exports = function (plop) {
       },
     ],
   });
-};
+}