From 70a9939f9a9a85823c62e52dd34ee7df7a94af1f Mon Sep 17 00:00:00 2001 From: Li Kang Date: Tue, 20 Sep 2022 08:43:13 +0200 Subject: [PATCH] docs: fix a option description for config --- commands/build/README.md | 2 +- commands/build/lib/init-config.js | 2 +- commands/serve/README.md | 2 +- commands/serve/lib/init-config.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/commands/build/README.md b/commands/build/README.md index 970025a94..4a520be82 100644 --- a/commands/build/README.md +++ b/commands/build/README.md @@ -17,7 +17,7 @@ Build nebula.js visualization Options: --version Show version number [boolean] - --config, -c Path to JSON config file + --config, -c Path to a JavaScript config file [string] [default: "nebula.config.js"] --watch, -w Watch source files [choices: "umd", "systemjs"] [default: "umd"] diff --git a/commands/build/lib/init-config.js b/commands/build/lib/init-config.js index a6d808329..9e626e1d4 100644 --- a/commands/build/lib/init-config.js +++ b/commands/build/lib/init-config.js @@ -7,7 +7,7 @@ const RX = new RegExp(`${defaultFilename.replace(/\./g, '\\.')}$`); const options = { config: { type: 'string', - description: 'Path to config file', + description: 'Path to a JavaScript config file', default: defaultFilename, alias: 'c', }, diff --git a/commands/serve/README.md b/commands/serve/README.md index f900d0812..42a86390b 100644 --- a/commands/serve/README.md +++ b/commands/serve/README.md @@ -19,7 +19,7 @@ Start a development server Options: --version Show version number [boolean] - --config, -c Path to JSON config file + --config, -c Path to a JavaScript config file [string] [default: "nebula.config.js"] --entry File entrypoint [string] --type Generic object type [string] diff --git a/commands/serve/lib/init-config.js b/commands/serve/lib/init-config.js index 7a3735306..29a30646e 100644 --- a/commands/serve/lib/init-config.js +++ b/commands/serve/lib/init-config.js @@ -8,7 +8,7 @@ const RX = new RegExp(`${defaultFilename.replace(/\./g, '\\.')}$`); const options = { config: { type: 'string', - description: 'Path to config file', + description: 'Path to a JavaScript config file', default: defaultFilename, alias: 'c', },