cli-kiss 0.0.3 → 0.0.4

package/tests/unit.command.usage.ts

@@ -11,6 +11,8 @@ import {
   optionRepeatable,
   optionSingleValue,
   ReaderTokenizer,
+  typeCommaList,
+  typeCommaTuple,
   typeNumber,
   typeString,
 } from "../src";
@@ -18,11 +20,8 @@ import { usageToPrintableLines } from "../src/lib/Usage";
 
 const cmd = commandWithSubcommands<string, any, any>(
   {
-    title: "Root command title",
-    description: [
-      "Root command description",
-      "Second line of root command description",
-    ],
+    description: "Root command description",
+    details: ["Root command details", "Second line of root command details"],
   },
   execution(
     {
@@ -40,11 +39,10 @@ const cmd = commandWithSubcommands<string, any, any>(
           label: "COOL-STUFF",
           description: "Root string-option description",
         }),
-        numberOption: optionRepeatable({
-          short: "n",
-          long: "number-option",
-          type: typeNumber,
-          description: "Root number-option description",
+        complexOption: optionRepeatable({
+          long: "complex-option",
+          type: typeCommaTuple([typeNumber, typeCommaList(typeString)]),
+          description: "Root complex-option description",
         }),
       },
       arguments: [
@@ -67,10 +65,10 @@ const cmd = commandWithSubcommands<string, any, any>(
   {
     sub1: command(
       {
-        title: "Subcommand 1 title",
-        description: [
-          "Subcommand 1 description",
-          "Second line of subcommand 1 description",
+        description: "Subcommand 1 description",
+        details: [
+          "Subcommand 1 details",
+          "Second line of subcommand 1 details",
         ],
       },
       execution(
@@ -91,10 +89,10 @@ const cmd = commandWithSubcommands<string, any, any>(
     ),
     sub2: command(
       {
-        title: "Subcommand 2 title",
-        description: [
-          "Subcommand 2 description",
-          "Second line of subcommand 2 description",
+        description: "Subcommand 2 description",
+        details: [
+          "Subcommand 2 details",
+          "Second line of subcommand 2 details",
         ],
       },
       execution(
@@ -120,7 +118,7 @@ const cmd = commandWithSubcommands<string, any, any>(
               default: () => "42",
             }),
             argumentVariadics({
-              label: "VARIADIC-POSS",
+              label: "VARIADIC",
               description: "Variadic positional arguments",
               type: typeString,
             }),
@@ -135,57 +133,58 @@ const cmd = commandWithSubcommands<string, any, any>(
 );
 
 it("run", async () => {
-  const usage1 = getUsage([], cmd);
+  const usage1 = await getUsage([], cmd);
+  // console.log(usage1.join("\n"));
   expect(usage1).toStrictEqual([
+    "{Root command description}+",
+    "{Root command details}@brightBlack",
+    "{Second line of root command details}@brightBlack",
     "",
-    "{Root command title}+",
-    "{Root command description}@grey",
-    "{Second line of root command description}@grey",
+    "{Usage:}@brightGreen+",
+    "  {my-cli}@brightCyan+ {<POS-1>}@brightBlue {<POS-2>}@brightBlue {<SUBCOMMAND>}@brightCyan+",
     "",
-    "{Usage:}@green+ {my-cli}@cyan+ {<POS-1>}@cyan {<POS-2>}@cyan {<SUBCOMMAND>}@cyan+",
+    "{Arguments:}@brightGreen+",
+    "{  }{<POS-1>}@brightBlue{  }{First positional argument}+",
+    "{  }{<POS-2>}@brightBlue{  }{Second positional argument}+",
     "",
-    "{Arguments:}@green+",
-    " {<POS-1>}@cyan  {First positional argument}+",
-    " {<POS-2>}@cyan  {Second positional argument}+",
+    "{Subcommands:}@brightGreen+",
+    "{  }{sub1}@brightCyan+{  }{Subcommand 1 description}+",
+    "{  }{sub2}@brightCyan+{  }{Subcommand 2 description}+",
     "",
-    "{Options:}@green+",
-    " {-b}@cyan+{,} {--boolean-flag}@cyan+{[=yes|no]}@grey       {Root boolean-flag description}+",
-    " {-s}@cyan+{,} {--string-option }@cyan+{<COOL-STUFF>}@cyan  {Root string-option description}+",
-    " {-n}@cyan+{,} {--number-option }@cyan+{<NUMBER>}@cyan      {Root number-option description}+",
-    "",
-    "{Subcommands:}@green+",
-    " {sub1}@cyan+  {Subcommand 1 title}+",
-    " {sub2}@cyan+  {Subcommand 2 title}+",
+    "{Options:}@brightGreen+",
+    "{  }{-b}@brightCyan+{, }{--boolean-flag}@brightCyan+                              {  }{Root boolean-flag description}+",
+    "{  }{-s}@brightCyan+{, }{--string-option }@brightCyan+{<COOL-STUFF>}@brightBlue                {  }{Root string-option description}+",
+    "{  }    {--complex-option }@brightCyan+{<NUMBER,STRING[,STRING...]>}@brightBlue{  }{Root complex-option description}+",
     "",
   ]);
 
-  const usage2 = getUsage(["50", "51", "sub1", "final"], cmd);
+  const usage2 = await getUsage(["50", "51", "sub1", "final"], cmd);
   expect(usage2).toStrictEqual([
+    "{Subcommand 1 description}+",
+    "{Subcommand 1 details}@brightBlack",
+    "{Second line of subcommand 1 details}@brightBlack",
     "",
-    "{Subcommand 1 title}+",
-    "{Subcommand 1 description}@grey",
-    "{Second line of subcommand 1 description}@grey",
-    "",
-    "{Usage:}@green+ {my-cli}@cyan+ {<POS-1>}@cyan {<POS-2>}@cyan {sub1}@cyan+ {<POS-STRING>}@cyan",
+    "{Usage:}@brightGreen+",
+    "  {my-cli}@brightCyan+ {<POS-1>}@brightBlue {<POS-2>}@brightBlue {sub1}@brightCyan+ {<POS-STRING>}@brightBlue",
     "",
-    "{Arguments:}@green+",
-    " {<POS-1>}@cyan       {First positional argument}+",
-    " {<POS-2>}@cyan       {Second positional argument}+",
-    " {<POS-STRING>}@cyan  {Positional string argument}+",
+    "{Arguments:}@brightGreen+",
+    "{  }{<POS-1>}@brightBlue     {  }{First positional argument}+",
+    "{  }{<POS-2>}@brightBlue     {  }{Second positional argument}+",
+    "{  }{<POS-STRING>}@brightBlue{  }{Positional string argument}+",
     "",
-    "{Options:}@green+",
-    " {-b}@cyan+{,} {--boolean-flag}@cyan+{[=yes|no]}@grey       {Root boolean-flag description}+",
-    " {-s}@cyan+{,} {--string-option }@cyan+{<COOL-STUFF>}@cyan  {Root string-option description}+",
-    " {-n}@cyan+{,} {--number-option }@cyan+{<NUMBER>}@cyan      {Root number-option description}+",
+    "{Options:}@brightGreen+",
+    "{  }{-b}@brightCyan+{, }{--boolean-flag}@brightCyan+                              {  }{Root boolean-flag description}+",
+    "{  }{-s}@brightCyan+{, }{--string-option }@brightCyan+{<COOL-STUFF>}@brightBlue                {  }{Root string-option description}+",
+    "{  }    {--complex-option }@brightCyan+{<NUMBER,STRING[,STRING...]>}@brightBlue{  }{Root complex-option description}+",
     "",
   ]);
 
-  const usage3 = getUsage(
+  const usage3 = await getUsage(
     [
       "40",
       "41",
       "sub2",
-      "--string-option=hello",
+      "--complex-option=42,hello,world",
       "--number-option",
       "123",
       "--number-option",
@@ -198,34 +197,41 @@ it("run", async () => {
     cmd,
   );
   expect(usage3).toStrictEqual([
-    "",
-    "{Subcommand 2 title}+",
-    "{Subcommand 2 description}@grey",
-    "{Second line of subcommand 2 description}@grey",
-    "",
-    "{Usage:}@green+ {my-cli}@cyan+ {<POS-1>}@cyan {<POS-2>}@cyan {sub2}@cyan+ {<POS-NUMBER>}@cyan {[OPT-POS]}@cyan {[VARIADIC-POSS...]}@cyan",
-    "",
-    "{Arguments:}@green+",
-    " {<POS-1>}@cyan             {First positional argument}+",
-    " {<POS-2>}@cyan             {Second positional argument}+",
-    " {<POS-NUMBER>}@cyan        {Positional number argument}+",
-    " {[OPT-POS]}@cyan           {Optional positional argument}+",
-    " {[VARIADIC-POSS...]}@cyan  {Variadic positional arguments}+",
-    "",
-    "{Options:}@green+",
-    " {-b}@cyan+{,} {--boolean-flag}@cyan+{[=yes|no]}@grey       {Root boolean-flag description}+",
-    " {-s}@cyan+{,} {--string-option }@cyan+{<COOL-STUFF>}@cyan  {Root string-option description}+",
-    " {-n}@cyan+{,} {--number-option }@cyan+{<NUMBER>}@cyan      {Root number-option description}+",
-    "     {--dudu }@cyan+{<STRING>}@cyan               {Dudu option description}+",
+    "{Subcommand 2 description}+",
+    "{Subcommand 2 details}@brightBlack",
+    "{Second line of subcommand 2 details}@brightBlack",
+    "",
+    "{Usage:}@brightGreen+",
+    "  {my-cli}@brightCyan+ {<POS-1>}@brightBlue {<POS-2>}@brightBlue {sub2}@brightCyan+ {<POS-NUMBER>}@brightBlue {[OPT-POS]}@brightBlue {[VARIADIC...]}@brightBlue",
+    "",
+    "{Arguments:}@brightGreen+",
+    "{  }{<POS-1>}@brightBlue      {  }{First positional argument}+",
+    "{  }{<POS-2>}@brightBlue      {  }{Second positional argument}+",
+    "{  }{<POS-NUMBER>}@brightBlue {  }{Positional number argument}+",
+    "{  }{[OPT-POS]}@brightBlue    {  }{Optional positional argument}+",
+    "{  }{[VARIADIC...]}@brightBlue{  }{Variadic positional arguments}+",
+    "",
+    "{Options:}@brightGreen+",
+    "{  }{-b}@brightCyan+{, }{--boolean-flag}@brightCyan+                              {  }{Root boolean-flag description}+",
+    "{  }{-s}@brightCyan+{, }{--string-option }@brightCyan+{<COOL-STUFF>}@brightBlue                {  }{Root string-option description}+",
+    "{  }    {--complex-option }@brightCyan+{<NUMBER,STRING[,STRING...]>}@brightBlue{  }{Root complex-option description}+",
+    "{  }    {--dudu }@brightCyan+{<STRING>}@brightBlue                             {  }{Dudu option description}+",
     "",
   ]);
 });
 
-function getUsage<Context, Result>(
+async function getUsage<Context, Result>(
   argv: Array<string>,
   command: Command<Context, Result>,
 ) {
   const commandRunner = command.prepareRunner(new ReaderTokenizer(argv));
+  /*
+  try {
+    console.log(await commandRunner.execute({} as Context));
+  } catch (error) {
+    console.error("Error during execution:", error);
+  }
+    */
   return usageToPrintableLines({
     cliName: "my-cli",
     commandUsage: commandRunner.computeUsage(),