feat: add exit code for prompt test (#1)

* feat: add exitCode

* test: add exit code 0

* docs: update usage info

* test: update test suite

Co-authored-by: jamesgeorge007 <[email protected]>

Author: TheSTL

README.md

@@ -46,29 +46,38 @@ const cliPath = `${__dirname}/cli.js`;
 
 describe("cli-prompts-test", () => {
   it("picks first option", async () => {
-    const { stdout } = await runTest(
+    const { exitCode, stdout } = await runTest(
       [cliPath],
       [ENTER]
     );
+
+    // Assertions
+    expect(exitCode).toBe(0);
     expect(stdout).toContain("You chose First option");
   });
 
   it("picks second option", async () => {
-    const { stdout } = await runTest(
+    const { exitCode, stdout } = await runTest(
       [cliPath],
       [`${DOWN}${ENTER}`]
     );
+
+    // Assertions
+    expect(exitCode).toBe(0);
     expect(stdout).toContain("You chose Second option");
   });
 
   it("picks third option", async () => {
-    const { stdout } = await runTest(
+    const { exitCode, stdout } = await runTest(
       [cliPath],
       [`${DOWN}${DOWN}${ENTER}`]
     );
+
+    // Assertions
+    expect(exitCode).toBe(0);
     expect(stdout).toContain("You chose Third option");
   });
 });
 ```
 
-Find an example [here](https://github.com/madlabsinc/mevn-cli/blob/develop/jest/helpers.js).
+Find an example [here](https://github.com/madlabsinc/mevn-cli/blob/develop/jest/helpers.js).

index.js

@@ -37,31 +37,22 @@ module.exports = (args, answers, options) => {
   return new Promise((resolve) => {
     const obj = {};
 
-    // Booleans to keep track of completion status
-    let stdoutCompleted = false;
-    let stderrCompleted = false;
-
-    const resolveWithObj = () => {
-      if (stdoutCompleted && stderrCompleted) {
-        resolve(obj);
-      }
-    };
-
     runner.stdout.pipe(
       concat((result) => {
-        stdoutCompleted = true;
         obj.stdout = result.toString();
-        resolveWithObj();
       })
     );
 
     runner.stderr.pipe(
       concat((result) => {
-        stderrCompleted = true;
         obj.stderr = result.toString();
-        resolveWithObj();
       })
     );
+
+    runner.on("exit", (exitCode) => {
+      obj.exitCode = exitCode;
+      resolve(obj);
+    });
   });
 };
 

test/fixtures/cli-exit-code.js

@@ -0,0 +1,15 @@
+const enquirer = require("enquirer");
+
+enquirer
+  .prompt({
+    type: "input",
+    name: "text",
+    message: "Please input some text",
+  })
+  .then(({ text }) => {
+    if (!text) {
+      console.error("Invalid input");
+      process.exit(1);
+    }
+    console.log(text);
+  });

test/test.js

@@ -1,27 +1,57 @@
 "use strict";
 
+const path = require("path");
+
 const runTest = require("../");
 
 const DOWN = "\x1B\x5B\x42";
 const ENTER = "\x0D";
 const SPACE = "\x20";
 
-const cliPath = `${__dirname}/fixtures/cli.js`;
+const fixturesPath = path.join(__dirname, "fixtures");
+const cliPath = path.join(fixturesPath, "cli.js");
+const cliExitCodePath = path.join(fixturesPath, "cli-exit-code.js");
 
 describe("cli-prompts-test", () => {
   it("picks a single option", async () => {
-    const { stdout } = await runTest(
+    const { exitCode, stdout } = await runTest(
       [cliPath],
       [`${DOWN}${DOWN}${SPACE}${ENTER}`]
     );
+
+    // Assertions
+    expect(exitCode).toBe(0);
     expect(stdout).toContain("You chose blue");
   });
 
   it("picks multiple options", async () => {
-    const { stdout } = await runTest(
+    const { exitCode, stdout } = await runTest(
       [cliPath],
       [`${SPACE}${DOWN}${DOWN}${DOWN}${SPACE}${ENTER}${DOWN}${SPACE}${ENTER}`]
     );
+
+    // Assertions
+    expect(exitCode).toBe(0);
     expect(stdout).toContain("You chose aqua, fuchsia, green");
   });
+
+  it("returns an exit code of 0", async () => {
+    const { exitCode, stderr, stdout } = await runTest(
+      [cliExitCodePath],
+      ["sample text", ENTER]
+    );
+
+    // Assertions
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain("sample text");
+    expect(stderr).toBeFalsy();
+  });
+
+  it("returns an exit code of 1", async () => {
+    const { exitCode, stderr } = await runTest([cliExitCodePath], [ENTER]);
+
+    // Assertions
+    expect(exitCode).toBe(1);
+    expect(stderr).toContain("Invalid input");
+  });
 });