Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
fix: update --web-socket-server description (#4098)
  • Loading branch information
snitin315 committed Dec 11, 2021
1 parent 7abcde1 commit 65955e9
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. 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.
Expand Down
6 changes: 3 additions & 3 deletions bin/cli-flags.js
Expand Up @@ -319,15 +319,15 @@ module.exports = {
configs: [
{
description:
"Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.",
"Deprecated: please use '--web-socket-server-type' option.",
multiple: false,
path: "webSocketServer",
type: "enum",
values: [false],
},
{
description:
"Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.",
"Deprecated: please use '--web-socket-server-type' option.",
multiple: false,
path: "webSocketServer",
type: "enum",
Expand All @@ -343,7 +343,7 @@ module.exports = {
],

description:
"Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. 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,
},
Expand Down
2 changes: 1 addition & 1 deletion lib/options.json
Expand Up @@ -1031,7 +1031,7 @@
"$ref": "#/definitions/WebSocketServerType"
}
],
"description": "Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option."
"description": "Deprecated: please use '--web-socket-server-type' option."
},
"WebSocketServerFunction": {
"instanceof": "Function"
Expand Down
4 changes: 2 additions & 2 deletions test/__snapshots__/validate-options.test.js.snap.webpack4
Expand Up @@ -908,7 +908,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
Details:
* options.webSocketServer should be one of these:
false | \\"sockjs\\" | \\"ws\\"
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
-> Deprecated: please use '--web-socket-server-type' option.
Details:
* options.webSocketServer should be false.
* options.webSocketServer should be one of these:
Expand All @@ -928,7 +928,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
Details:
* options.webSocketServer should be one of these:
false | \\"sockjs\\" | \\"ws\\"
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
-> Deprecated: please use '--web-socket-server-type' option.
Details:
* options.webSocketServer should be false.
* options.webSocketServer should be one of these:
Expand Down
4 changes: 2 additions & 2 deletions test/__snapshots__/validate-options.test.js.snap.webpack5
Expand Up @@ -908,7 +908,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
Details:
* options.webSocketServer should be one of these:
false | \\"sockjs\\" | \\"ws\\"
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
-> Deprecated: please use '--web-socket-server-type' option.
Details:
* options.webSocketServer should be false.
* options.webSocketServer should be one of these:
Expand All @@ -928,7 +928,7 @@ exports[`options validate should throw an error on the "webSocketServer" option
Details:
* options.webSocketServer should be one of these:
false | \\"sockjs\\" | \\"ws\\"
-> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option.
-> Deprecated: please use '--web-socket-server-type' option.
Details:
* options.webSocketServer should be false.
* options.webSocketServer should be one of these:
Expand Down
2 changes: 1 addition & 1 deletion test/cli/__snapshots__/basic.test.js.snap.webpack4
Expand Up @@ -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> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. 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.
Expand Down
2 changes: 1 addition & 1 deletion test/cli/__snapshots__/basic.test.js.snap.webpack5
Expand Up @@ -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> Deprecated: please use 'webSocketServer.type'/'--web-socket-server-type' option. 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').

Expand Down

0 comments on commit 65955e9

Please sign in to comment.