fix: update description for --no-client (#4250)

webpack · Feb 6, 2022 · c3b6690 · c3b6690
1 parent 72cdfa4
commit c3b6690
Show file tree

Hide file tree

Showing 7 changed files with 379 additions and 392 deletions.
diff --git a/README.md b/README.md
@@ -90,7 +90,7 @@ Options:
                                             you are proxying dev server, by default is 'auto').
   --bonjour                                 Allows to broadcasts dev server via ZeroConf networking on start.
   --no-bonjour                              Disallows to broadcasts dev server via ZeroConf networking on start.
-  --no-client                               Negative 'client' option.
+  --no-client                               Disables client script.
   --client-logging <value>                  Allows to set log level in the browser.
   --client-overlay                          Enables a full-screen overlay in the browser when there are compiler errors or warnings.
   --no-client-overlay                       Disables a full-screen overlay in the browser when there are compiler errors or warnings.

diff --git a/bin/cli-flags.js b/bin/cli-flags.js
@@ -61,6 +61,7 @@ module.exports = {
       {
         description:
           "Allows to specify options for client script in the browser or disable client script.",
+        negatedDescription: "Disables client script.",
         multiple: false,
         path: "client",
         type: "enum",

diff --git a/lib/options.json b/lib/options.json
@@ -47,7 +47,10 @@
       "link": "https://webpack.js.org/configuration/dev-server/#devserverclient",
       "anyOf": [
         {
-          "enum": [false]
+          "enum": [false],
+          "cli": {
+            "negatedDescription": "Disables client script."
+          }
         },
         {
           "type": "object",

diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack4 b/test/cli/__snapshots__/basic.test.js.snap.webpack4
@@ -58,7 +58,7 @@ Options:
   --allowed-hosts-reset                     Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto').
   --bonjour                                 Allows to broadcasts dev server via ZeroConf networking on start.
   --no-bonjour                              Disallows to broadcasts dev server via ZeroConf networking on start.
-  --no-client                               Negative 'client' option.
+  --no-client                               Disables client script.
   --client-logging <value>                  Allows to set log level in the browser.
   --client-overlay                          Enables a full-screen overlay in the browser when there are compiler errors or warnings.
   --no-client-overlay                       Disables a full-screen overlay in the browser when there are compiler errors or warnings.

diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack5 b/test/cli/__snapshots__/basic.test.js.snap.webpack5
@@ -59,7 +59,7 @@ Options:
   --allowed-hosts-reset                     Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto').
   --bonjour                                 Allows to broadcasts dev server via ZeroConf networking on start.
   --no-bonjour                              Disallows to broadcasts dev server via ZeroConf networking on start.
-  --no-client                               Negative 'client' option.
+  --no-client                               Disables client script.
   --client-logging <value>                  Allows to set log level in the browser.
   --client-overlay                          Enables a full-screen overlay in the browser when there are compiler errors or warnings.
   --no-client-overlay                       Disables a full-screen overlay in the browser when there are compiler errors or warnings.

diff --git a/types/bin/cli-flags.d.ts b/types/bin/cli-flags.d.ts
@@ -45,6 +45,7 @@ declare const _exports: {
   client: {
     configs: {
       description: string;
+      negatedDescription: string;
       multiple: boolean;
       path: string;
       type: string;