From 42f5429fe5743bd183b909bb5ea750aee94245c7 Mon Sep 17 00:00:00 2001 From: Michael Orenstein Date: Mon, 24 Jul 2023 15:13:28 +0930 Subject: [PATCH] chore: Cli note for forwarding console logs --- README.md | 2 +- packages/storycap/src/node/cli.ts | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4dd76062f..9afca2e93 100644 --- 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 /. diff --git a/packages/storycap/src/node/cli.ts b/packages/storycap/src/node/cli.ts index 9983064b0..e5f042dd1 100644 --- 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,