feat: new option to display brief with custom usage

Signed-off-by: Michael Molisani <git@molisani.us>

packages/core/src/routing/command/documentation.ts

@@ -6,6 +6,11 @@ import { formatDocumentationForPositionalParameters } from "../../parameter/posi
 import type { CommandParameters } from "../../parameter/types";
 import type { HelpFormattingArguments } from "../types";
 
+export interface CustomUsage {
+    readonly input: string;
+    readonly brief: string;
+}
+
 export interface CommandDocumentation {
     /**
      * In-line documentation for this command.
@@ -18,7 +23,7 @@ export interface CommandDocumentation {
     /**
      * Sample usage to replace the generated usage lines.
      */
-    readonly customUsage?: readonly string[];
+    readonly customUsage?: readonly (string | CustomUsage)[];
 }
 
 /**
@@ -34,8 +39,13 @@ export function* generateCommandHelpLines(
     const prefix = args.prefix.join(" ");
     yield args.ansiColor ? `\x1B[1m${headers.usage}\x1B[22m` : headers.usage;
     if (customUsage) {
-        for (const customUsageLine of customUsage) {
-            yield `  ${prefix} ${customUsageLine}`;
+        for (const usage of customUsage) {
+            if (typeof usage === "string") {
+                yield `  ${prefix} ${usage}`;
+            } else {
+                const brief = args.ansiColor ? `\x1B[3m${usage.brief}\x1B[23m` : usage.brief;
+                yield `  ${prefix} ${usage.input}\n    ${brief}`;
+            }
         }
     } else {
         yield `  ${formatUsageLineForParameters(parameters, args)}`;

packages/core/tests/application.spec.ts

@@ -674,7 +674,7 @@ describe("Application", () => {
                     },
                     docs: {
                         brief: "basic command",
-                        customUsage: ["custom usage 1", "custom usage 2", "custom usage 3"],
+                        customUsage: ["custom usage 1", { input: "custom-two", brief: "enhanced custom usage 2" }, "custom usage 3"],
                     },
                 });
                 const appWithAlternateUsage = buildApplication(commandWithAlternateUsage, {
@@ -1526,6 +1526,65 @@ describe("Application", () => {
                 compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
             });
         });
+
+        describe("nested basic route map with hidden routes, always show help-all (alias)", () => {
+            // GIVEN
+            const rootRouteMap = buildRouteMapForFakeContext({
+                routes: {
+                    sub: buildBasicRouteMap("sub"),
+                    subHidden: buildBasicRouteMap("subHidden"),
+                },
+                docs: {
+                    brief: "root route map",
+                    hideRoute: {
+                        subHidden: true,
+                    },
+                },
+            });
+            const app = buildApplication(rootRouteMap, {
+                name: "cli",
+                documentation: {
+                    alwaysShowHelpAllFlag: true,
+                    useAliasInUsageLine: true,
+                },
+            });
+
+            // WHEN
+            it("display help text for root (implicit)", async function () {
+                const result = await runWithInputs(app, []);
+                compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
+            });
+
+            it("display help text for root", async function () {
+                const result = await runWithInputs(app, ["--help"]);
+                compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
+            });
+
+            it("display help text for root including hidden", async function () {
+                const result = await runWithInputs(app, ["--help-all"]);
+                compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
+            });
+
+            it("fails for undefined route", async function () {
+                const result = await runWithInputs(app, ["undefined"]);
+                compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
+            });
+
+            it("fails for undefined flag", async function () {
+                const result = await runWithInputs(app, ["--undefined"]);
+                compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
+            });
+
+            it("displays help text for nested hidden route map (implicit)", async function () {
+                const result = await runWithInputs(app, ["subHidden"]);
+                compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
+            });
+
+            it("displays help text for nested hidden route map", async function () {
+                const result = await runWithInputs(app, ["subHidden", "--help"]);
+                compareToBaseline(this, ApplicationRunResultBaselineFormat, result);
+            });
+        });
     });
 
     describe("proposeCompletions", () => {

packages/core/tests/baselines/reference/application.txt

@@ -245,7 +245,8 @@ ExitCode=Success
 :: STDOUT
 USAGE
   cli custom usage 1
-  cli custom usage 2
+  cli custom-two
+    enhanced custom usage 2
   cli custom usage 3
   cli --help
 
@@ -1085,6 +1086,117 @@ ExitCode=UnknownCommand
 :: STDERR
 No command registered for `undefined`
 
+:::: Application / run / nested basic route map with hidden routes, always show help-all (alias) / display help text for root
+ExitCode=Success
+:: STDOUT
+USAGE
+  cli sub command ...
+  cli -h
+  cli -H
+
+root route map
+
+FLAGS
+  -h --help     Print help information and exit
+  -H --helpAll  Print help information (including hidden commands/flags) and exit
+
+COMMANDS
+  sub  sub
+
+:: STDERR
+
+:::: Application / run / nested basic route map with hidden routes, always show help-all (alias) / display help text for root (implicit)
+ExitCode=Success
+:: STDOUT
+USAGE
+  cli sub command ...
+  cli -h
+  cli -H
+
+root route map
+
+FLAGS
+  -h --help     Print help information and exit
+  -H --helpAll  Print help information (including hidden commands/flags) and exit
+
+COMMANDS
+  sub  sub
+
+:: STDERR
+
+:::: Application / run / nested basic route map with hidden routes, always show help-all (alias) / display help text for root including hidden
+ExitCode=Success
+:: STDOUT
+USAGE
+  cli sub command ...
+  cli subHidden command ...
+  cli -h
+  cli -H
+
+root route map
+
+FLAGS
+  -h --help     Print help information and exit
+  -H --helpAll  Print help information (including hidden commands/flags) and exit
+
+COMMANDS
+  sub        sub
+  subHidden  subHidden
+
+:: STDERR
+
+:::: Application / run / nested basic route map with hidden routes, always show help-all (alias) / displays help text for nested hidden route map
+ExitCode=Success
+:: STDOUT
+USAGE
+  cli subHidden command
+  cli subHidden -h
+  cli subHidden -H
+
+subHidden
+
+FLAGS
+  -h --help     Print help information and exit
+  -H --helpAll  Print help information (including hidden commands/flags) and exit
+
+COMMANDS
+  command  basic command
+
+:: STDERR
+
+:::: Application / run / nested basic route map with hidden routes, always show help-all (alias) / displays help text for nested hidden route map (implicit)
+ExitCode=Success
+:: STDOUT
+USAGE
+  cli subHidden command
+  cli subHidden -h
+  cli subHidden -H
+
+subHidden
+
+FLAGS
+  -h --help     Print help information and exit
+  -H --helpAll  Print help information (including hidden commands/flags) and exit
+
+COMMANDS
+  command  basic command
+
+:: STDERR
+
+:::: Application / run / nested basic route map with hidden routes, always show help-all (alias) / fails for undefined flag
+ExitCode=UnknownCommand
+:: STDOUT
+
+:: STDERR
+No command registered for `--undefined`
+
+:::: Application / run / nested basic route map with hidden routes, always show help-all (alias) / fails for undefined route
+ExitCode=UnknownCommand
+:: STDOUT
+
+:: STDERR
+No command registered for `undefined`
+
 :::: Application / run / nested basic route map with hidden routes, always show help-all / display help text for root
 ExitCode=Success
 :: STDOUT

packages/core/tests/baselines/reference/routing/command.txt

@@ -256,6 +256,26 @@ USAGE
 
 brief
 
+FLAGS
+  -a  --alpha            alpha flag brief
+      --bravo...         bravo flag brief
+     [--charlie]         charlie flag brief
+  -d  --delta/--noDelta  delta flag brief
+  -h  --help             Print help information and exit
+
+ARGUMENTS
+  args...  string array brief
+
+:::: Command / printHelp / mixed parameters, enhanced custom usage
+USAGE
+  prefix -a 1
+    enhanced usage line #1
+  prefix -a 2 -d
+    enhanced usage line #2
+  prefix --help
+
+brief
+
 FLAGS
   -a  --alpha            alpha flag brief
       --bravo...         bravo flag brief
@@ -307,6 +327,49 @@ USAGE
 
 Longer description of this command's behavior, only printed during --help
 
+FLAGS
+  -a  --alpha            alpha flag brief
+      --bravo...         bravo flag brief
+     [--charlie]         charlie flag brief
+  -d  --delta/--noDelta  delta flag brief
+  -h  --help             Print help information and exit
+
+ARGUMENTS
+  args...  string array brief
+
+:::: Command / printHelp / mixed parameters, help all, force alias in usage line
+USAGE
+  prefix (-a value) (--bravo value)... [--charlie c] (-d) <args>...
+  prefix -h
+  prefix -H
+
+brief
+
+FLAGS
+  -a  --alpha            alpha flag brief
+      --bravo...         bravo flag brief
+     [--charlie]         charlie flag brief
+  -d  --delta/--noDelta  delta flag brief
+  -h  --help             Print help information and exit
+  -H  --helpAll          Print help information (including hidden commands/flags) and exit
+
+ARGUMENTS
+  args...  string array brief
+
+:::: Command / printHelp / mixed parameters, mixed custom usage
+USAGE
+  prefix -a 1
+    enhanced usage line #1
+  prefix normal custom usage A
+  prefix normal custom usage B
+  prefix -a 2 -d
+    enhanced usage line #2
+  prefix normal custom usage C
+  prefix normal custom usage D
+  prefix --help
+
+brief
+
 FLAGS
   -a  --alpha            alpha flag brief
       --bravo...         bravo flag brief
@@ -442,6 +505,18 @@ brief
 FLAGS
   -h --help  Print help information and exit
 
+:::: Command / printHelp / no parameters, help all, force alias in usage line
+USAGE
+  prefix
+  prefix -h
+  prefix -H
+
+brief
+
+FLAGS
+  -h --help     Print help information and exit
+  -H --helpAll  Print help information (including hidden commands/flags) and exit
+
 :::: Command / run / command function returns error / with custom exit code
 ExitCode=Unknown(10)
 :: STDOUT