Skip to content

Commit 65955e9

Browse files
authored
fix: update --web-socket-server description (#4098)
1 parent 7abcde1 commit 65955e9

7 files changed

+11
-11
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Options:
109109
--client-web-socket-url-protocol <value> Tells clients connected to devServer to use the provided protocol.
110110
--client-web-socket-url-username <value> Tells clients connected to devServer to use the provided username to authenticate.
111111
--client-web-socket-url-password <value> Tells clients connected to devServer to use the provided password to authenticate.
112-
--web-socket-server <value> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
112+
--web-socket-server <value> Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
113113
--no-web-socket-server Negative 'web-socket-server' option.
114114
--web-socket-server-type <value> Allows to set web socket server and options (by default 'ws').
115115
--compress Enables gzip compression for everything served.

bin/cli-flags.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -319,15 +319,15 @@ module.exports = {
319319
configs: [
320320
{
321321
description:
322-
"Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.",
322+
"Deprecated: please use '--web-socket-server-type' option.",
323323
multiple: false,
324324
path: "webSocketServer",
325325
type: "enum",
326326
values: [false],
327327
},
328328
{
329329
description:
330-
"Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.",
330+
"Deprecated: please use '--web-socket-server-type' option.",
331331
multiple: false,
332332
path: "webSocketServer",
333333
type: "enum",
@@ -343,7 +343,7 @@ module.exports = {
343343
],
344344

345345
description:
346-
"Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').",
346+
"Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').",
347347
simpleType: "string",
348348
multiple: false,
349349
},

lib/options.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1031,7 +1031,7 @@
10311031
"$ref": "#/definitions/WebSocketServerType"
10321032
}
10331033
],
1034-
"description": "Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option."
1034+
"description": "Deprecated: please use '--web-socket-server-type' option."
10351035
},
10361036
"WebSocketServerFunction": {
10371037
"instanceof": "Function"

test/__snapshots__/validate-options.test.js.snap.webpack4

+2-2
Original file line numberDiff line numberDiff line change
@@ -908,7 +908,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
908908
Details:
909909
* options.webSocketServer should be one of these:
910910
false | \\"sockjs\\" | \\"ws\\"
911-
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
911+
-> Deprecated: please use '--web-socket-server-type' option.
912912
Details:
913913
* options.webSocketServer should be false.
914914
* options.webSocketServer should be one of these:
@@ -928,7 +928,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
928928
Details:
929929
* options.webSocketServer should be one of these:
930930
false | \\"sockjs\\" | \\"ws\\"
931-
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
931+
-> Deprecated: please use '--web-socket-server-type' option.
932932
Details:
933933
* options.webSocketServer should be false.
934934
* options.webSocketServer should be one of these:

test/__snapshots__/validate-options.test.js.snap.webpack5

+2-2
Original file line numberDiff line numberDiff line change
@@ -908,7 +908,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
908908
Details:
909909
* options.webSocketServer should be one of these:
910910
false | \\"sockjs\\" | \\"ws\\"
911-
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
911+
-> Deprecated: please use '--web-socket-server-type' option.
912912
Details:
913913
* options.webSocketServer should be false.
914914
* options.webSocketServer should be one of these:
@@ -928,7 +928,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
928928
Details:
929929
* options.webSocketServer should be one of these:
930930
false | \\"sockjs\\" | \\"ws\\"
931-
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
931+
-> Deprecated: please use '--web-socket-server-type' option.
932932
Details:
933933
* options.webSocketServer should be false.
934934
* options.webSocketServer should be one of these:

test/cli/__snapshots__/basic.test.js.snap.webpack4

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Options:
7878
--client-web-socket-url-protocol <value> Tells clients connected to devServer to use the provided protocol.
7979
--client-web-socket-url-username <value> Tells clients connected to devServer to use the provided username to authenticate.
8080
--client-web-socket-url-password <value> Tells clients connected to devServer to use the provided password to authenticate.
81-
--web-socket-server <value> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
81+
--web-socket-server <value> Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
8282
--no-web-socket-server Negative 'web-socket-server' option.
8383
--web-socket-server-type <value> Allows to set web socket server and options (by default 'ws').
8484
--compress Enables gzip compression for everything served.

test/cli/__snapshots__/basic.test.js.snap.webpack5

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Options:
147147
--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.
148148
--watch-files <value...> Allows to configure list of globs/directories/files to watch for file changes.
149149
--watch-files-reset Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes.
150-
--web-socket-server <value> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
150+
--web-socket-server <value> Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
151151
--no-web-socket-server Negative 'web-socket-server' option.
152152
--web-socket-server-type <value> Allows to set web socket server and options (by default 'ws').
153153

0 commit comments

Comments
 (0)