fix: update description for --web-socket-server option

webpack · Nov 5, 2021 · 5300e33 · 5300e33
1 parent 35a527f
commit 5300e33
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -109,7 +109,7 @@ Options:
   --client-web-socket-url-protocol <value>  Tells clients connected to devServer to use the provided protocol.
   --client-web-socket-url-username <value>  Tells clients connected to devServer to use the provided username to authenticate.
   --client-web-socket-url-password <value>  Tells clients connected to devServer to use the provided password to authenticate.
-  --web-socket-server <value>               Allows to set web socket server and options (by default 'ws').
+  --web-socket-server <value>               Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
   --no-web-socket-server                    Negative 'web-socket-server' option.
   --web-socket-server-type <value>          Allows to set web socket server and options (by default 'ws').
   --compress                                Enables gzip compression for everything served.

diff --git a/bin/cli-flags.js b/bin/cli-flags.js
@@ -321,15 +321,15 @@ module.exports = {
     configs: [
       {
         description:
-          "Allows to set web socket server and options (by default 'ws').",
+          "Deprecated: please use '--web-socket-server-type' option.",
         multiple: false,
         path: "webSocketServer",
         type: "enum",
         values: [false],
       },
       {
         description:
-          "Allows to set web socket server and options (by default 'ws').",
+          "Deprecated: please use '--web-socket-server-type' option.",
         multiple: false,
         path: "webSocketServer",
         type: "enum",
@@ -345,7 +345,7 @@ module.exports = {
     ],
 
     description:
-      "Allows to set web socket server and options (by default 'ws').",
+      "Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').",
     simpleType: "string",
     multiple: false,
   },

diff --git a/lib/options.json b/lib/options.json
@@ -1026,7 +1026,8 @@
         {
           "$ref": "#/definitions/WebSocketServerType"
         }
-      ]
+      ],
+      "description": "Deprecated: please use '--web-socket-server-type' option."
     },
     "WebSocketServerFunction": {
       "instanceof": "Function"

diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack4 b/test/cli/__snapshots__/basic.test.js.snap.webpack4
@@ -78,7 +78,7 @@ Options:
   --client-web-socket-url-protocol <value>  Tells clients connected to devServer to use the provided protocol.
   --client-web-socket-url-username <value>  Tells clients connected to devServer to use the provided username to authenticate.
   --client-web-socket-url-password <value>  Tells clients connected to devServer to use the provided password to authenticate.
-  --web-socket-server <value>               Allows to set web socket server and options (by default 'ws').
+  --web-socket-server <value>               Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
   --no-web-socket-server                    Negative 'web-socket-server' option.
   --web-socket-server-type <value>          Allows to set web socket server and options (by default 'ws').
   --compress                                Enables gzip compression for everything served.

diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack5 b/test/cli/__snapshots__/basic.test.js.snap.webpack5
@@ -147,7 +147,7 @@ Options:
   --static-public-path-reset                Clear all items provided in 'static.publicPath' configuration. The static files will be available in the browser under this public path.
   --watch-files <value...>                  Allows to configure list of globs/directories/files to watch for file changes.
   --watch-files-reset                       Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes.
-  --web-socket-server <value>               Allows to set web socket server and options (by default 'ws').
+  --web-socket-server <value>               Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
   --no-web-socket-server                    Negative 'web-socket-server' option.
   --web-socket-server-type <value>          Allows to set web socket server and options (by default 'ws').