Merge pull request #300 from Pike/error-on-failure

Return error code on failures on actions

src/plop.js

@@ -121,6 +121,7 @@ async function run(env, _, passArgsBeforeDashes) {
 // everybody to the plop!
 //
 function doThePlop(generator, bypassArr) {
+  let failedActions = false;
   generator
     .runPrompts(bypassArr)
     .then(async (answers) => {
@@ -156,12 +157,16 @@ function doThePlop(generator, bypassArr) {
           line += ` ${errMsg}`;
         }
         progressSpinner.fail(line);
+        failedActions = true;
         progressSpinner.start();
       };
       progressSpinner.start();
       return generator
         .runActions(answers, { onSuccess, onFailure, onComment })
-        .then(() => progressSpinner.stop());
+        .then(() => {
+          progressSpinner.stop();
+          if (failedActions) process.exit(1);
+        });
     })
     .catch(function (err) {
       console.error(chalk.red("[ERROR]"), err.message);

tests/action-failure.spec.js

@@ -0,0 +1,22 @@
+import { resolve, dirname } from "node:path";
+import { waitFor } from "cli-testing-library";
+import { renderPlop } from "./render.js";
+
+import { fileURLToPath } from "node:url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+test("should exit with code 1 when failed actions", async () => {
+  const result = await renderPlop([], {
+    cwd: resolve(__dirname, "./examples/action-failure"),
+  });
+  const { findByText, userEvent } = result;
+  expect(await findByText("What is your name?")).toBeTruthy();
+  userEvent.keyboard("Joe");
+  expect(await findByText("Joe")).toBeTruthy();
+  userEvent.keyboard("[Enter]");
+  const actionOutput = await findByText("Action failed");
+  await waitFor(() =>
+    expect(actionOutput.hasExit()).toStrictEqual({ exitCode: 1 })
+  );
+});

tests/examples/action-failure/package.json

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

tests/examples/action-failure/plopfile.js

@@ -0,0 +1,17 @@
+export default function (plop) {
+  plop.setGenerator("test", {
+    description: "this is a test",
+    prompts: [
+      {
+        type: "input",
+        name: "name",
+        message: "What is your name?",
+      },
+    ],
+    actions: [
+      () => {
+        throw new Error("Action failed");
+      },
+    ],
+  });
+}