test(shell): convertion from coffee to js

Author: wdavidw

packages/shell/package.json

@@ -30,7 +30,6 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.15.0",
-    "coffeescript": "^2.7.0",
     "dedent": "^1.5.3",
     "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.1.0",
@@ -71,7 +70,6 @@
       "should"
     ],
     "inline-diffs": true,
-    "loader": "./test/loaders/coffee.js",
     "timeout": 10000,
     "reporter": "spec",
     "recursive": true
@@ -91,7 +89,7 @@
     "lint:staged": "npx lint-staged",
     "preversion": "yarn run test",
     "pretest": "npm run build",
-    "test": "mocha 'test/**/*.coffee' 'test/**/*.js'"
+    "test": "mocha 'test/**/*.js'"
   },
   "type": "module",
   "gitHead": "437629d1d64e73173408e67832c0c735b1225fdc"

packages/shell/test/api.load.js

@@ -8,15 +8,15 @@ describe("api.load", function () {
     const cwd = process.cwd();
     process.chdir(os.tmpdir());
     await fs.writeFile(
-      `${os.tmpdir()}/relative_module.coffee`,
+      `${os.tmpdir()}/relative_module.js`,
       dedent`
-    export default (params) -> params
+    export default (params) => params
     `,
     );
-    const mod = await shell().load(`${os.tmpdir()}/relative_module.coffee`);
+    const mod = await shell().load(`${os.tmpdir()}/relative_module.js`);
     mod("my value").should.eql("my value");
     process.chdir(cwd);
-    await fs.unlink(`${os.tmpdir()}/relative_module.coffee`);
+    await fs.unlink(`${os.tmpdir()}/relative_module.js`);
   });
 
   it("load is not a string", async function () {

packages/shell/test/args/api.compile.coffee

@@ -0,0 +1,67 @@
+import { shell } from "../../lib/index.js";
+
+describe("api.compile", function () {
+  it("validate", function () {
+    (function () {
+      shell().compile({}, "invalid");
+    }).should.throw(
+      'Invalid Compile Arguments: 2nd argument option must be an object, got "invalid"',
+    );
+  });
+
+  it("command string is converted to a 1 element array internally", function () {
+    shell({
+      commands: {
+        start: {},
+      },
+    })
+      .compile({
+        command: "start",
+      })
+      .should.eql(["start"]);
+  });
+
+  it("catch main argument with type of string", function () {
+    (function () {
+      shell({
+        main: "leftover",
+      }).compile({
+        leftover: "my value",
+      });
+    }).should.throw(
+      'Invalid Parameter Type: expect main to be an array, got "my value"',
+    );
+  });
+
+  it("check a command is registered", function () {
+    (function () {
+      shell({
+        commands: {
+          start: {},
+          stop: {},
+        },
+      }).compile({
+        command: ["status"],
+      });
+    }).should.throw(
+      'Invalid Command Parameter: command "status" is not registed, expect one of ["help","start","stop"]',
+    );
+
+    (function () {
+      shell({
+        commands: {
+          server: {
+            commands: {
+              start: {},
+              stop: {},
+            },
+          },
+        },
+      }).compile({
+        command: ["server", "status"],
+      });
+    }).should.throw(
+      'Invalid Command Parameter: command "status" is not registed, expect one of ["start","stop"] in command "server"',
+    );
+  });
+});

packages/shell/test/args/api.compile.js

@@ -0,0 +1,31 @@
+import { shell } from "../../lib/index.js";
+
+describe("api.compile.script", function () {
+  it("should prefix with node path and executed script", function () {
+    shell({
+      commands: {
+        start: {
+          options: {
+            myparam: {},
+          },
+        },
+      },
+    })
+      .compile(
+        {
+          command: "start",
+          myparam: "my value",
+        },
+        {
+          script: "./bin/myscript",
+        },
+      )
+      .should.eql([
+        process.execPath,
+        "./bin/myscript",
+        "start",
+        "--myparam",
+        "my value",
+      ]);
+  });
+});

packages/shell/test/args/api.compile.script.coffee

@@ -0,0 +1,24 @@
+import { shell } from "../../lib/index.js";
+
+describe("api.parse.extended", function () {
+  it("overwrite flatten mode", function () {
+    shell({
+      options: {
+        my_option: {},
+      },
+    })
+      .parse(["--my_option", "my value"], { extended: true })
+      .should.eql([{ my_option: "my value" }]);
+  });
+
+  it("overwrite extended mode", function () {
+    shell({
+      options: {
+        my_option: {},
+      },
+      extended: true,
+    })
+      .parse(["--my_option", "my value"], { extended: false })
+      .should.eql({ my_option: "my value" });
+  });
+});

packages/shell/test/args/api.compile.script.js

@@ -0,0 +1,81 @@
+import { shell } from "../../lib/index.js";
+
+describe("api.parse", function () {
+  it("does not alter input arguments", function () {
+    const app = shell({
+      commands: {
+        start: {
+          options: {
+            my_option: {
+              shortcut: "w",
+            },
+          },
+        },
+      },
+    });
+    const argv = ["start", "--my_option", "my value"];
+    app.parse(argv);
+    argv.should.eql(["start", "--my_option", "my value"]);
+  });
+
+  it("catch argument without a value because end of argv", function () {
+    const app = shell({
+      commands: {
+        start: {
+          options: {
+            an_int: {
+              type: "integer",
+            },
+            a_string: {
+              type: "string",
+            },
+            an_array: {
+              type: "array",
+            },
+          },
+        },
+      },
+    });
+    (function () {
+      app.parse(["start", "--an_int"]);
+    }).should.throw('Invalid Option: no value found for option "an_int"');
+    (function () {
+      app.parse(["start", "--a_string"]);
+    }).should.throw('Invalid Option: no value found for option "a_string"');
+    (function () {
+      app.parse(["start", "--an_array"]);
+    }).should.throw('Invalid Option: no value found for option "an_array"');
+  });
+
+  it("catch argument without a value because next argv is a shortcut", function () {
+    const app = shell({
+      commands: {
+        start: {
+          options: {
+            an_int: {
+              type: "integer",
+            },
+            a_string: {
+              type: "string",
+            },
+            an_array: {
+              type: "array",
+            },
+            some: {
+              type: "string",
+            },
+          },
+        },
+      },
+    });
+    (function () {
+      app.parse(["start", "--an_int", "--some", "thing"]);
+    }).should.throw('Invalid Option: no value found for option "an_int"');
+    (function () {
+      app.parse(["start", "--a_string", "--some", "thing"]);
+    }).should.throw('Invalid Option: no value found for option "a_string"');
+    (function () {
+      app.parse(["start", "--an_array", "--some", "thing"]);
+    }).should.throw('Invalid Option: no value found for option "an_array"');
+  });
+});