fix(rstack): align CLI help messages (#324)

Author: chenjiahan

packages/rstack/src/cli/commands.ts

@@ -5,7 +5,7 @@ import { hasHelpFlag, renderHelp } from './help.ts';
 
 const renderRootHelp = (): string =>
   renderHelp({
-    usage: 'rs [command] [...options]',
+    usage: 'rs [command] [options]',
     sections: [
       {
         title: 'Commands',
@@ -48,6 +48,7 @@ const renderCheckHelp = (): string =>
         title: 'Options',
         items: [
           ['--type-check', 'Enable TypeScript type checking'],
+          ['-c, --config <path>', 'Specify Rstack config file path'],
           ['-h, --help', 'Display this help message'],
         ],
       },
@@ -182,10 +183,7 @@ const renderDocEjectHelp = (): string =>
     sections: [
       {
         title: 'Options',
-        items: [
-          ['-c, --config <path>', 'Specify Rstack config file path'],
-          ['-h, --help', 'Display this help message'],
-        ],
+        items: [['-h, --help', 'Display this help message']],
       },
     ],
   });

packages/rstack/src/fmt/cli.ts

@@ -46,6 +46,7 @@ const renderFmtHelp = (): string =>
           ['--with-node-modules', 'Process files inside node_modules'],
           ['--parallel-workers <count>', 'Number of parallel workers'],
           ['--stdin-filepath <path>', 'Format stdin as if it were saved at <path>'],
+          ['-c, --config <path>', 'Specify Rstack config file path'],
           ['-h, --help', 'Display this help message'],
         ],
       },

packages/rstack/src/setup/index.ts

@@ -6,7 +6,7 @@ import { installHooks } from './install.ts';
 const renderSetupHelp = (): string =>
   renderHelp({
     usage: 'rs setup [options]',
-    description: 'Install Git hooks in the current repository.',
+    description: 'Install Git hooks in the current repository',
     sections: [
       {
         title: 'Options',

packages/rstack/src/staged.ts

@@ -36,13 +36,14 @@ const renderStagedHelp = (): string =>
           ],
           ['--cwd <path>', 'Working directory to run all tasks in'],
           ['-d, --debug', 'Print additional debug information'],
-          ['--no-stash', 'Disable the backup stash. Implies "--no-revert".'],
+          ['--no-stash', 'Disable backup stash and automatic revert'],
           ['-q, --quiet', "Disable lint-staged's own console output"],
           ['-r, --relative', 'Pass relative filepaths to tasks'],
           [
             '-v, --verbose',
             'Show task output even when tasks succeed; by default only failed output is shown',
           ],
+          ['-c, --config <path>', 'Specify Rstack config file path'],
           ['-h, --help', 'Display this help message'],
         ],
       },

packages/rstack/tests/cli/__snapshots__/check.test.ts.snap

@@ -9,7 +9,8 @@ Usage:
 Run static checks, including lint and format
 
 Options:
-  --type-check  Enable TypeScript type checking
-  -h, --help    Display this help message
+  --type-check         Enable TypeScript type checking
+  -c, --config <path>  Specify Rstack config file path
+  -h, --help           Display this help message
 "
 `;

packages/rstack/tests/cli/__snapshots__/help.test.ts.snap

@@ -59,8 +59,7 @@ Usage:
 Eject a theme component
 
 Options:
-  -c, --config <path>  Specify Rstack config file path
-  -h, --help           Display this help message
+  -h, --help  Display this help message
 "
 `;
 
@@ -340,7 +339,7 @@ exports[`displays top-level help 1`] = `
 "Rstack v<version>
 
 Usage:
-  $ rs [command] [...options]
+  $ rs [command] [options]
 
 Commands:
   dev          Run the app dev server

packages/rstack/tests/cli/fmt/__snapshots__/files.test.ts.snap

@@ -20,6 +20,7 @@ Options:
   --with-node-modules              Process files inside node_modules
   --parallel-workers <count>       Number of parallel workers
   --stdin-filepath <path>          Format stdin as if it were saved at <path>
+  -c, --config <path>              Specify Rstack config file path
   -h, --help                       Display this help message
 "
 `;

packages/rstack/tests/cli/setup/__snapshots__/index.test.ts.snap

@@ -6,7 +6,7 @@ exports[`displays setup help 1`] = `
 Usage:
   $ rs setup [options]
 
-Install Git hooks in the current repository.
+Install Git hooks in the current repository
 
 Options:
   --hooks-dir <path>  Specify hooks directory relative to the Git repository root

packages/rstack/tests/cli/staged/__snapshots__/index.test.ts.snap

@@ -13,10 +13,11 @@ Options:
   -p, --concurrent <number|boolean>  The number of tasks to run concurrently, or false for serial
   --cwd <path>                       Working directory to run all tasks in
   -d, --debug                        Print additional debug information
-  --no-stash                         Disable the backup stash. Implies "--no-revert".
+  --no-stash                         Disable backup stash and automatic revert
   -q, --quiet                        Disable lint-staged's own console output
   -r, --relative                     Pass relative filepaths to tasks
   -v, --verbose                      Show task output even when tasks succeed; by default only failed output is shown
+  -c, --config <path>                Specify Rstack config file path
   -h, --help                         Display this help message
 "
 `;