chore: Cli note for forwarding console logs

reg-viz · Jul 24, 2023 · dc6e853 · dc6e853
1 parent 2bddf42
commit dc6e853
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -363,7 +363,7 @@ Options:
       --disableWaitAssets          Disable waiting for requested assets                       [boolean] [default: false]
       --silent                                                                                [boolean] [default: false]
       --verbose                                                                               [boolean] [default: false]
-      --forwardConsoleLogs                                                                    [boolean] [default: false]
+      --forwardConsoleLogs         Forward in-page console logs to the user's console.        [boolean] [default: false]
       --serverCmd                  Command line to launch Storybook server.                       [string] [default: ""]
       --serverTimeout              Timeout [msec] for starting Storybook server.               [number] [default: 60000]
       --shard                      The sharding options for this run. In the format <shardNumber>/<totalShards>.

diff --git a/packages/storycap/src/node/cli.ts b/packages/storycap/src/node/cli.ts
@@ -36,7 +36,11 @@ function createOptions(): MainOptions {
     })
     .option('silent', { boolean: true, default: false })
     .option('verbose', { boolean: true, default: false })
-    .option('forwardConsoleLogs', { boolean: true, default: false })
+    .option('forwardConsoleLogs', {
+      boolean: true,
+      default: false,
+      description: "Forward in-page console logs to the user's console.",
+    })
     .option('serverCmd', { string: true, default: '', description: 'Command line to launch Storybook server.' })
     .option('serverTimeout', {
       number: true,