feat(breadc): cli usage

yjl9903 · Feb 4, 2023 · 0ad8218 · 0ad8218
1 parent e19cfa0
commit 0ad8218
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 2 deletions.
diff --git a/packages/breadc/src/breadc.ts b/packages/breadc/src/breadc.ts
@@ -19,7 +19,10 @@ export function breadc(name: string, config: AppOption = {}) {
       }
 
       initContextOptions(
-        [makeHelpCommand(name, config), makeVersionCommand(name, config)],
+        [
+          makeHelpCommand(name, config, allCommands),
+          makeVersionCommand(name, config)
+        ],
         context
       );
     },

diff --git a/packages/breadc/src/command.ts b/packages/breadc/src/command.ts
@@ -268,7 +268,11 @@ export function makeVersionCommand(name: string, config: AppOption): Option {
 type HelpBlcok = string | Array<[string, string]>;
 type HelpMessage = Array<HelpBlcok | (() => HelpBlcok[] | undefined)>;
 
-export function makeHelpCommand(name: string, config: AppOption): Option {
+export function makeHelpCommand(
+  name: string,
+  config: AppOption,
+  allCommands: Command[]
+): Option {
   function expandMessage(message: HelpMessage) {
     const result: string[] = [];
     for (const row of message) {
@@ -311,6 +315,15 @@ export function makeHelpCommand(name: string, config: AppOption): Option {
     return commands;
   }
 
+  const usage =
+    allCommands.length === 0
+      ? `[OPTIONS]`
+      : allCommands.length === 1
+      ? `[OPTIONS] ${allCommands[0].format}`
+      : allCommands.some((c) => c._default)
+      ? `[OPTIONS] [COMMAND]`
+      : `[OPTIONS] <COMMAND>`;
+
   const command: Command = {
     async callback(parsed) {
       // @ts-ignore
@@ -327,6 +340,8 @@ export function makeHelpCommand(name: string, config: AppOption): Option {
             return undefined;
           }
         },
+        '',
+        `${bold(underline('Usage:'))} ${bold(name)} ${usage}`,
         () => {
           const cmds = expandCommands(cursor);
           if (cmds.length > 0) {

diff --git a/packages/breadc/test/command.test.ts b/packages/breadc/test/command.test.ts
@@ -82,6 +82,8 @@ describe('Help command', () => {
 
       This is a cli app.
 
+      Usage: cli [OPTIONS] [COMMAND]
+
       Commands:
         cli [root]        Start dev server
         cli build [root]  Build static site
@@ -97,6 +99,8 @@ describe('Help command', () => {
 
       This is a cli app.
 
+      Usage: cli [OPTIONS] [COMMAND]
+
       Commands:
         cli [root]        Start dev server
         cli build [root]  Build static site
@@ -121,6 +125,8 @@ describe('Help command', () => {
 
       This is a cli app.
 
+      Usage: cli [OPTIONS] [COMMAND]
+
       Commands:
         cli build [root]  Build static site
 
@@ -146,6 +152,8 @@ describe('Help command', () => {
 
       This is a cli app.
 
+      Usage: cli [OPTIONS] <COMMAND>
+
       Commands:
         cli store ls [path]   List path
         cli store rm [path]   Remove path
@@ -162,6 +170,8 @@ describe('Help command', () => {
 
       This is a cli app.
 
+      Usage: cli [OPTIONS] <COMMAND>
+
       Commands:
         cli file info [path]  Get file info
         cli store ls [path]   List path
@@ -179,6 +189,8 @@ describe('Help command', () => {
 
       This is a cli app.
 
+      Usage: cli [OPTIONS] <COMMAND>
+
       Commands:
         cli store ls [path]  List path
 
@@ -197,6 +209,8 @@ describe('Help command', () => {
     expect(await cli.run(['-h'])).toMatchInlineSnapshot(`
       "cli/unknown
 
+      Usage: cli [OPTIONS]
+
       Options:
         -h, --host <addr>  Host address
             --remote       Enable remote
@@ -218,6 +232,8 @@ describe('Help command', () => {
     expect(await cli.run(['-h'])).toMatchInlineSnapshot(`
       "cli/unknown
 
+      Usage: cli [OPTIONS] build
+
       Commands:
         cli build  Build static site
 
@@ -232,6 +248,8 @@ describe('Help command', () => {
     expect(await cli.run(['build', '-h'])).toMatchInlineSnapshot(`
       "cli/unknown
 
+      Usage: cli [OPTIONS] build
+
       Commands:
         cli build  Build static site