cli-kiss 0.1.0 → 0.1.2

package/tests/{unit.runner.test1.ts → unit.runner.cycle.ts}

@@ -16,12 +16,14 @@ import {
   typeUrl,
 } from "../src";
 
+// TODO - unit test for color styling
+
 it("run", async () => {
   const rootUsage = [
-    "Root Description",
-    "",
     "Usage: my-cli <REQUIRED1> <SUBCOMMAND>",
     "",
+    "Root Description",
+    "",
     "Positionals:",
     "  <REQUIRED1>  Required1 positional description",
     "",
@@ -35,10 +37,10 @@ it("run", async () => {
     "",
   ].join("\n");
   const subcommandUsage = [
-    "Subcommand Description",
-    "",
     "Usage: my-cli <REQUIRED1> subcommand <REQUIRED2> [OPTIONAL] [VARIADICS]...",
     "",
+    "Subcommand Description",
+    "",
     "Positionals:",
     "  <REQUIRED1>     Required1 positional description",
     "  <REQUIRED2>     Required2 positional description",
@@ -53,9 +55,31 @@ it("run", async () => {
     "",
   ].join("\n");
 
-  await testCase(["required1", "subcommand", "required2"], [], [], 0);
+  // Test that everything could work normally
+  await testCase(
+    ["required1", "subcommand", "required2"],
+    ["Has executed root command", "Has executed subcommand"],
+    [],
+    0,
+  );
+
+  // Check that version flag takes precedence over execution
   await testCase(["--version"], ["my-cli 1.0.0"], [], 0);
+  await testCase(["required1", "--version"], ["my-cli 1.0.0"], [], 0);
+  await testCase(
+    ["required1", "subcommand", "--version"],
+    ["my-cli 1.0.0"],
+    [],
+    0,
+  );
+  await testCase(
+    ["required1", "subcommand", "required2", "--version"],
+    ["my-cli 1.0.0"],
+    [],
+    0,
+  );
 
+  // Check that help flag takes precedence over execution
   await testCase(["--help"], [rootUsage], [], 0);
   await testCase(["required1", "--help"], [rootUsage], [], 0);
   await testCase(
@@ -71,109 +95,129 @@ it("run", async () => {
     0,
   );
 
+  // Help takes precedence over version
+  await testCase(["--version", "--help"], [rootUsage], [], 0);
+  await testCase(["--help", "--version"], [rootUsage], [], 0);
+
+  // Test missing required inputs
   await testCase(
     [],
     [],
-    [rootUsage, "Error: Missing required positional argument: REQUIRED1"],
+    [rootUsage, "Error: <REQUIRED1>: Is required, but was not provided"],
     1,
   );
   await testCase(
     ["required1"],
     [],
-    [rootUsage, "Error: Missing required positional argument: SUBCOMMAND"],
+    [rootUsage, "Error: <SUBCOMMAND>: Is required, but was not provided"],
     1,
   );
   await testCase(
     ["required1", "subcommand"],
     [],
-    [subcommandUsage, "Error: Missing required positional argument: REQUIRED2"],
+    [subcommandUsage, "Error: <REQUIRED2>: Is required, but was not provided"],
     1,
   );
+
+  // Test that flags become available when subcommand is known
   await testCase(
-    ["required1", "subcommand", "invalid"],
+    ["--url", "https://example.com"],
     [],
-    [
-      subcommandUsage,
-      'Error: REQUIRED2: Unexpected value: "invalid" (expected: "required2"|"required2-bis")',
-    ],
+    [rootUsage, "Error: --url: Unexpected unknown option"],
     1,
   );
-
   await testCase(
-    ["required1", "subcommand", "required2", "--nope"],
+    ["required1", "--url", "https://example.com"],
     [],
-    [subcommandUsage, "Error: Unknown option: --nope"],
+    [rootUsage, "Error: --url: Unexpected unknown option"],
     1,
   );
   await testCase(
-    ["required1", "subcommand", "required2", "--url"],
+    ["required1", "subcommand", "--url", "https://example.com"],
     [],
-    [
-      subcommandUsage,
-      "Error: Option parsing: --url: requires a value, but got end of input",
-    ],
+    [subcommandUsage, "Error: <REQUIRED2>: Is required, but was not provided"],
     1,
   );
   await testCase(
-    ["required1", "subcommand", "required2", "--url", "not-a-url"],
+    ["required1", "subcommand", "required2", "--url", "https://example.com"],
+    ["Has executed root command", "Has executed subcommand"],
     [],
-    [subcommandUsage, "Error: --url: URL: TypeError: Invalid URL"],
-    1,
+    0,
   );
 
+  // Test option as flag parsing cases
   await testCase(
-    ["required1", "--url", "https://example.com"],
+    ["--flag", "--flag", "required1", "subcommand", "required2"],
     [],
-    [rootUsage, `Error: Unknown option: --url`],
+    [subcommandUsage, "Error: --flag: Must not be set multiple times"],
     1,
   );
   await testCase(
-    ["required1", "subcommand", "--url", "https://example.com"],
+    ["--flag=42", "required1", "subcommand", "required2"],
     [],
-    [subcommandUsage, "Error: Missing required positional argument: REQUIRED2"],
+    [subcommandUsage, 'Error: --flag: <BOOLEAN>: Invalid value: "42"'],
     1,
   );
   await testCase(
-    ["required1", "subcommand", "required2", "--url", "https://example.com"],
+    ["--flag=no", "required1", "subcommand", "required2"],
+    ["Has executed root command", "Has executed subcommand"],
     [],
+    0,
+  );
+  await testCase(
+    ["--flag=yes", "required1", "subcommand", "required2"],
+    ["Has executed root command", "Has executed subcommand"],
     [],
     0,
   );
 
+  // Test option parsing errors
   await testCase(
     ["--invalid", "required1", "subcommand", "required2"],
     [],
-    [rootUsage, `Error: Unknown option: --invalid`],
+    [rootUsage, "Error: --invalid: Unexpected unknown option"],
     1,
   );
   await testCase(
-    ["--flag", "--flag", "required1", "subcommand", "required2"],
+    ["required1", "subcommand", "required2", "--nope"],
     [],
-    [
-      subcommandUsage,
-      "Error: Option value for: --flag: must not be set multiple times",
-    ],
+    [subcommandUsage, "Error: --nope: Unexpected unknown option"],
     1,
   );
   await testCase(
-    ["--flag=42", "required1", "subcommand", "required2"],
+    ["required1", "subcommand", "required2", "--url"],
     [],
-    [subcommandUsage, 'Error: --flag: BOOLEAN: Invalid value: "42"'],
+    [subcommandUsage, "Error: --url: requires a value, but got end of input"],
     1,
   );
+
+  // Test invalid input values type decoding errors
   await testCase(
-    ["--flag=no", "required1", "subcommand", "required2"],
-    [],
+    ["required1", "subcommand", "invalid"],
     [],
-    0,
+    [
+      subcommandUsage,
+      'Error: <REQUIRED2>: Unexpected value: "invalid" (expected: "required2"|"required2-bis")',
+    ],
+    1,
   );
   await testCase(
-    ["--flag=yes", "required1", "subcommand", "required2"],
+    ["required1", "subcommand", "required2", "--single-value=44"],
     [],
+    [
+      subcommandUsage,
+      'Error: --single-value: <NUMBER>: Unexpected value: "44" (expected: "42"|"43")',
+    ],
+    1,
+  );
+  await testCase(
+    ["required1", "subcommand", "required2", "--url", "not-a-url"],
     [],
-    0,
+    [subcommandUsage, "Error: --url: <URL>: TypeError: Invalid URL"],
+    1,
   );
 
+  // Test option multiple value parsing cases
   await testCase(
     [
       "required1",
@@ -183,7 +227,7 @@ it("run", async () => {
       "--repeatable",
       "43",
     ],
-    [],
+    ["Has executed root command", "Has executed subcommand"],
     [],
     0,
   );
@@ -197,19 +241,7 @@ it("run", async () => {
       "43",
     ],
     [],
-    [
-      subcommandUsage,
-      "Error: Option value for: --single-value: must not be set multiple times",
-    ],
-    1,
-  );
-  await testCase(
-    ["required1", "subcommand", "required2", "--single-value=44"],
-    [],
-    [
-      subcommandUsage,
-      'Error: --single-value: NUMBER: Unexpected value: "44" (expected: "42"|"43")',
-    ],
+    [subcommandUsage, "Error: --single-value: Must not be set multiple times"],
     1,
   );
 });
@@ -220,7 +252,16 @@ async function testCase(
   expectStdErr: Array<string>,
   expectExit: number,
 ) {
-  const cmd = commandWithSubcommands<null, null, void>(
+  const onLogStdOut = makeMocked<string, void>([
+    null as unknown as void,
+    null as unknown as void,
+  ]);
+  const onLogStdErr = makeMocked<string, void>([
+    null as unknown as void,
+    null as unknown as void,
+  ]);
+  const onExit = makeMocked<number, never>([null as never]);
+  const cmd = commandWithSubcommands<null, void, void>(
     { description: "Root Description" },
     operation(
       {
@@ -250,7 +291,7 @@ async function testCase(
         ],
       },
       async () => {
-        return null;
+        onLogStdOut.call("Has executed root command");
       },
     ),
     {
@@ -284,20 +325,13 @@ async function testCase(
               }),
             ],
           },
-          async () => {},
+          async () => {
+            onLogStdOut.call("Has executed subcommand");
+          },
         ),
       ),
     },
   );
-  const onLogStdOut = makeMocked<string, void>([
-    null as unknown as void,
-    null as unknown as void,
-  ]);
-  const onLogStdErr = makeMocked<string, void>([
-    null as unknown as void,
-    null as unknown as void,
-  ]);
-  const onExit = makeMocked<number, never>([null as never]);
   await runAsCliAndExit("my-cli", args, null, cmd, {
     buildVersion: "1.0.0",
     onExit: onExit.call,