fix: improve description for 'configtest' command (#2379)

webpack · Jan 28, 2021 · 311bae3 · 311bae3
1 parent 6b31614
commit 311bae3
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/OPTIONS.md b/OPTIONS.md
@@ -794,7 +794,7 @@ Global options:
 
 Commands:
   build|bundle|b [entries...] [options]                                              Run webpack (default command, can be omitted).
-  configtest|t [config-path]                                                         Tests webpack configuration against validation errors.
+  configtest|t [config-path]                                                         Validate a webpack configuration.
   help|h [command] [option]                                                          Display help for commands and options.
   info|i [options]                                                                   Outputs information about your system.
   init|c [scaffold...] [options]                                                     Initialize a new webpack configuration.

diff --git a/packages/configtest/package.json b/packages/configtest/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@webpack-cli/configtest",
   "version": "1.0.0",
-  "description": "Tests webpack configuration against validation errors.",
+  "description": "Validate a webpack configuration.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "license": "MIT",

diff --git a/packages/configtest/src/index.ts b/packages/configtest/src/index.ts
@@ -6,7 +6,7 @@ class ConfigTestCommand {
             {
                 name: 'configtest [config-path]',
                 alias: 't',
-                description: 'Tests webpack configuration against validation errors.',
+                description: 'Validate a webpack configuration.',
                 pkg: '@webpack-cli/configtest',
             },
             [],

diff --git a/packages/webpack-cli/README.md b/packages/webpack-cli/README.md
@@ -63,17 +63,17 @@ npx webpack-cli --help verbose
 ### Available Commands
 
 ```
-  build|bundle|b [options]                   Run webpack (default command, can be omitted).
-  watch|w [options]                          Run webpack and watch for files changes.
-  version|v [commands...]                    Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
+  build|bundle|b [entries...] [options]      Run webpack (default command, can be omitted).
+  configtest|t [config-path]                 Validate a webpack configuration.
   help|h [command] [option]                  Display help for commands and options.
-  serve|s [options]                          Run the webpack dev server.
   info|i [options]                           Outputs information about your system.
-  init|c [options] [scaffold...]             Initialize a new webpack configuration.
+  init|c [scaffold...] [options]             Initialize a new webpack configuration.
   loader|l [output-path]                     Scaffold a loader.
   migrate|m <config-path> [new-config-path]  Migrate a configuration to a new version.
-  configtest|t [config-path]                 Tests webpack configuration against validation errors.
   plugin|p [output-path]                     Scaffold a plugin.
+  serve|s [entries...] [options]             Run the webpack dev server.
+  version|v [commands...]                    Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
+  watch|w [entries...] [options]             Run webpack and watch for files changes.
 ```
 
 ### webpack 4