cli-kiss 0.0.1 → 0.0.2

package/src/lib/Usage.ts

@@ -1,104 +1,126 @@
 import { CommandUsage } from "./Command";
+import { GridCell, GridRow, gridToPrintableLines } from "./Grid";
+import { TypoSupport, TypoText, typoPrintableString } from "./Typo";
+
+export function usageToPrintableLines(params: {
+  cliName: string;
+  commandUsage: CommandUsage;
+  typoSupport: TypoSupport;
+}) {
+  const { cliName, commandUsage, typoSupport } = params;
 
-export function usageFormatter(
-  cliName: string,
-  commandUsage: CommandUsage,
-): string {
   const lines = new Array<string>();
+
+  lines.push("");
+  lines.push(typoPrintableString(typoSupport, textDesc(commandUsage.title)));
   if (commandUsage.description) {
-    lines.push("");
-    lines.push(commandUsage.description);
+    for (const descriptionLine of commandUsage.description) {
+      lines.push(typoPrintableString(typoSupport, textSubs(descriptionLine)));
+    }
   }
+
+  const breadcrumbPrefix = typoPrintableString(
+    typoSupport,
+    textTitle("Usage:"),
+  );
+  const breadcrumbsItems = [
+    typoPrintableString(typoSupport, textName(cliName)),
+  ].concat(
+    commandUsage.breadcrumbs.map((breadcrumb) => {
+      if (breadcrumb.kind === "argument") {
+        return typoPrintableString(typoSupport, textValue(breadcrumb.value));
+      }
+      return typoPrintableString(typoSupport, textName(breadcrumb.value));
+    }),
+  );
   lines.push("");
-  lines.push(`Usage: ${cliName} ${commandUsage.breadcrumbs.join(" ")}`);
+  lines.push(`${breadcrumbPrefix} ${breadcrumbsItems.join(" ")}`);
+
   if (commandUsage.arguments.length > 0) {
     lines.push("");
-    lines.push("Arguments:");
-    lines.push("");
-    const rows = new Array<Array<string>>();
+    lines.push(typoPrintableString(typoSupport, textTitle("Arguments:")));
+    const grid = new Array<GridRow>();
     for (const argumentUsage of commandUsage.arguments) {
-      const columns = new Array<string>();
-      columns.push("");
-      columns.push(argumentUsage.label);
-      columns.push("");
+      const gridRow = new Array<GridCell>();
+      gridRow.push([]);
+      gridRow.push([textValue(argumentUsage.label)]);
+      gridRow.push([]);
       if (argumentUsage.description) {
-        columns.push(argumentUsage.description);
+        gridRow.push([textDesc(argumentUsage.description)]);
       }
-      rows.push(columns);
+      grid.push(gridRow);
     }
-    pushGrid(lines, rows);
+    lines.push(...gridToPrintableLines(grid, typoSupport));
   }
+
   if (commandUsage.options.length > 0) {
     lines.push("");
-    lines.push("Options:");
-    lines.push("");
-    const rows = new Array<Array<string>>();
+    lines.push(typoPrintableString(typoSupport, textTitle("Options:")));
+    const grid = new Array<GridRow>();
     for (const optionUsage of commandUsage.options) {
-      const columns = new Array<string>();
-      columns.push("");
+      const gridRow = new Array<GridCell>();
+      gridRow.push([]);
       if (optionUsage.short) {
-        columns.push(`-${optionUsage.short},`);
+        gridRow.push([textName(`-${optionUsage.short}`), { value: "," }]);
       } else {
-        columns.push("");
+        gridRow.push([]);
       }
       if (optionUsage.label) {
-        columns.push(`--${optionUsage.long} ${optionUsage.label}`);
+        gridRow.push([
+          textName(`--${optionUsage.long} `),
+          textValue(optionUsage.label),
+        ]);
       } else {
-        columns.push(`--${optionUsage.long}`);
+        gridRow.push([
+          textName(`--${optionUsage.long}`),
+          { value: "[=yes|no]", color: "grey" },
+        ]);
       }
-      columns.push("");
+      gridRow.push([]);
       if (optionUsage.description) {
-        columns.push(optionUsage.description);
+        gridRow.push([textDesc(optionUsage.description)]);
       }
-      rows.push(columns);
+      grid.push(gridRow);
     }
-    pushGrid(lines, rows);
+    lines.push(...gridToPrintableLines(grid, typoSupport));
   }
+
   if (commandUsage.subcommands.length > 0) {
     lines.push("");
-    lines.push("Subcommands:");
-    lines.push("");
-    const rows = new Array<Array<string>>();
+    lines.push(typoPrintableString(typoSupport, textTitle("Subcommands:")));
+    const grid = new Array<GridRow>();
     for (const subcommand of commandUsage.subcommands) {
-      const columns = new Array<string>();
-      columns.push("");
-      columns.push(subcommand.name);
-      columns.push("");
-      if (subcommand.description) {
-        columns.push(subcommand.description);
+      const gridRow = new Array<GridCell>();
+      gridRow.push([]);
+      gridRow.push([textName(subcommand.name)]);
+      gridRow.push([]);
+      if (subcommand.title) {
+        gridRow.push([textDesc(subcommand.title)]);
       }
-      rows.push(columns);
+      grid.push(gridRow);
     }
-    pushGrid(lines, rows);
+    lines.push(...gridToPrintableLines(grid, typoSupport));
   }
   lines.push("");
-  return lines.join("\n");
+  return lines;
 }
 
-function pushGrid(lines: Array<string>, rows: Array<Array<string>>) {
-  const widths = new Array<number>();
-  for (const row of rows) {
-    for (let columnIndex = 0; columnIndex < row.length; columnIndex++) {
-      const cell = row[columnIndex]!;
-      if (
-        widths[columnIndex] === undefined ||
-        cell.length > widths[columnIndex]!
-      ) {
-        widths[columnIndex] = cell.length;
-      }
-    }
-  }
-  for (const row of rows) {
-    const cells = new Array<string>();
-    for (let columnIndex = 0; columnIndex < row.length; columnIndex++) {
-      const cell = row[columnIndex]!;
-      if (columnIndex < row.length - 1) {
-        const padding = " ".repeat(widths[columnIndex]! - cell.length);
-        cells.push(cell + padding);
-      } else {
-        cells.push(cell);
-      }
-    }
-    lines.push(cells.join(" "));
-  }
+function textTitle(text: string): TypoText {
+  return { value: text, color: "green", bold: true };
+}
+
+function textSubs(text: string): TypoText {
+  return { value: text, color: "grey" };
+}
+
+function textDesc(text: string): TypoText {
+  return { value: text, bold: true };
+}
+
+function textName(text: string): TypoText {
+  return { value: text, color: "cyan", bold: true };
+}
+
+function textValue(text: string): TypoText {
+  return { value: text, color: "cyan" };
 }

package/tests/unit.Reader.commons.ts

@@ -18,8 +18,8 @@ it("run", async () => {
     "-cd=4.1",
     "-ef5.1",
     "positional-2",
-    "-gh=false",
-    "-ij=true",
+    "-gh=FALSE",
+    "-ij=TRUE",
     "-b",
     "3.2",
     "-d=4.2",

package/tests/unit.command.run.ts

@@ -8,15 +8,15 @@ import {
   optionFlag,
   optionRepeatable,
   optionSingleValue,
-  processor,
+  process,
   runWithArgv,
   typeNumber,
   typeString,
 } from "../src";
 
 const cmd = commandWithSubcommands<string, any, any>(
-  "Root command description",
-  processor(
+  { title: "Root command title" },
+  process(
     {
       options: {
         booleanFlag: optionFlag({ long: "boolean-flag", default: () => false }),
@@ -41,8 +41,8 @@ const cmd = commandWithSubcommands<string, any, any>(
   ),
   {
     sub1: command(
-      "Subcommand 1 description",
-      processor(
+      { title: "Subcommand 1 title" },
+      process(
         {
           options: {},
           arguments: [argumentRequired({ type: typeString })],
@@ -53,8 +53,8 @@ const cmd = commandWithSubcommands<string, any, any>(
       ),
     ),
     sub2: command(
-      "Subcommand 2 description",
-      processor(
+      { title: "Subcommand 2 title" },
+      process(
         {
           options: {},
           arguments: [

package/tests/unit.command.usage.ts

@@ -9,16 +9,22 @@ import {
   optionFlag,
   optionRepeatable,
   optionSingleValue,
-  processor,
+  process,
   ReaderTokenizer,
   typeNumber,
   typeString,
 } from "../src";
-import { usageFormatter } from "../src/lib/Usage";
+import { usageToPrintableLines } from "../src/lib/Usage";
 
 const cmd = commandWithSubcommands<string, any, any>(
-  "Root command description",
-  processor(
+  {
+    title: "Root command title",
+    description: [
+      "Root command description",
+      "Second line of root command description",
+    ],
+  },
+  process(
     {
       options: {
         booleanFlag: optionFlag({
@@ -31,7 +37,7 @@ const cmd = commandWithSubcommands<string, any, any>(
           long: "string-option",
           type: typeString,
           default: () => undefined,
-          label: "COOL_STUFF",
+          label: "COOL-STUFF",
           description: "Root string-option description",
         }),
         numberOption: optionRepeatable({
@@ -43,12 +49,12 @@ const cmd = commandWithSubcommands<string, any, any>(
       },
       arguments: [
         argumentRequired({
-          label: "POSITIONAL-1",
+          label: "POS-1",
           description: "First positional argument",
           type: typeNumber,
         }),
         argumentRequired({
-          label: "POSITIONAL-2",
+          label: "POS-2",
           description: "Second positional argument",
           type: typeNumber,
         }),
@@ -60,8 +66,14 @@ const cmd = commandWithSubcommands<string, any, any>(
   ),
   {
     sub1: command(
-      "Subcommand 1 description",
-      processor(
+      {
+        title: "Subcommand 1 title",
+        description: [
+          "Subcommand 1 description",
+          "Second line of subcommand 1 description",
+        ],
+      },
+      process(
         {
           options: {},
           arguments: [
@@ -78,8 +90,14 @@ const cmd = commandWithSubcommands<string, any, any>(
       ),
     ),
     sub2: command(
-      "Subcommand 2 description",
-      processor(
+      {
+        title: "Subcommand 2 title",
+        description: [
+          "Subcommand 2 description",
+          "Second line of subcommand 2 description",
+        ],
+      },
+      process(
         {
           options: {
             duduValue: optionSingleValue({
@@ -96,13 +114,13 @@ const cmd = commandWithSubcommands<string, any, any>(
               type: typeNumber,
             }),
             argumentOptional({
-              label: "OPT-POSITIONAL",
+              label: "OPT-POS",
               description: "Optional positional argument",
               type: typeString,
               default: () => "42",
             }),
             argumentVariadics({
-              label: "VARIADIC-POSITIONALS",
+              label: "VARIADIC-POSS",
               description: "Variadic positional arguments",
               type: typeString,
             }),
@@ -117,14 +135,52 @@ const cmd = commandWithSubcommands<string, any, any>(
 );
 
 it("run", async () => {
-  const res0 = getUsage([], cmd);
-  console.log(res0);
+  const usage1 = getUsage([], cmd);
+  expect(usage1).toStrictEqual([
+    "",
+    "{Root command title}+",
+    "{Root command description}@grey",
+    "{Second line of root command description}@grey",
+    "",
+    "{Usage:}@green+ {my-cli}@cyan+ {<POS-1>}@cyan {<POS-2>}@cyan {<SUBCOMMAND>}@cyan+",
+    "",
+    "{Arguments:}@green+",
+    " {<POS-1>}@cyan  {First positional argument}+",
+    " {<POS-2>}@cyan  {Second positional 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}+",
+    "",
+    "{Subcommands:}@green+",
+    " {sub1}@cyan+  {Subcommand 1 title}+",
+    " {sub2}@cyan+  {Subcommand 2 title}+",
+    "",
+  ]);
 
-  const res1 = getUsage(["50", "51", "sub1", "final"], cmd);
-  console.log(res1);
-  //expect(res1).toStrictEqual({});
+  const usage2 = getUsage(["50", "51", "sub1", "final"], cmd);
+  expect(usage2).toStrictEqual([
+    "",
+    "{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",
+    "",
+    "{Arguments:}@green+",
+    " {<POS-1>}@cyan       {First positional argument}+",
+    " {<POS-2>}@cyan       {Second positional argument}+",
+    " {<POS-STRING>}@cyan  {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}+",
+    "",
+  ]);
 
-  const res2 = getUsage(
+  const usage3 = getUsage(
     [
       "40",
       "41",
@@ -141,7 +197,28 @@ it("run", async () => {
     ],
     cmd,
   );
-  console.log(res2);
+  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}+",
+    "",
+  ]);
 });
 
 function getUsage<Context, Result>(
@@ -149,5 +226,9 @@ function getUsage<Context, Result>(
   command: Command<Context, Result>,
 ) {
   const commandRunner = command.prepareRunner(new ReaderTokenizer(argv));
-  return usageFormatter("my-cli", commandRunner.computeUsage());
+  return usageToPrintableLines({
+    cliName: "my-cli",
+    commandUsage: commandRunner.computeUsage(),
+    typoSupport: "mock",
+  });
 }