From 88177c87beac220a6afbe4dfec2046973e72f3cf Mon Sep 17 00:00:00 2001 From: Nitin Kumar Date: Fri, 10 Dec 2021 06:38:27 +0530 Subject: [PATCH 1/3] fix: mark `--open-app` deprecated in favor of `--open-app-name` --- bin/cli-flags.js | 6 ++++-- lib/Server.js | 1 + lib/options.json | 3 ++- test/__snapshots__/validate-options.test.js.snap.webpack4 | 3 ++- test/__snapshots__/validate-options.test.js.snap.webpack5 | 3 ++- test/cli/__snapshots__/basic.test.js.snap.webpack4 | 2 +- test/cli/__snapshots__/basic.test.js.snap.webpack5 | 2 +- 7 files changed, 13 insertions(+), 7 deletions(-) diff --git a/bin/cli-flags.js b/bin/cli-flags.js index 8624d66266..3d8d07b78b 100644 --- a/bin/cli-flags.js +++ b/bin/cli-flags.js @@ -806,11 +806,13 @@ module.exports = { { type: "string", multiple: true, - description: "Open specified browser.", + description: + "Open specified browser. Deprecated: please use open.app.name/--open-app-name.", path: "open[].app", }, ], - description: "Open specified browser.", + description: + "Open specified browser. Deprecated: please use open.app.name/--open-app-name.", simpleType: "string", multiple: true, }, diff --git a/lib/Server.js b/lib/Server.js index baf8502445..312bfeea4b 100644 --- a/lib/Server.js +++ b/lib/Server.js @@ -910,6 +910,7 @@ class Server { // https://github.com/webpack/webpack-dev-server/issues/1990 const defaultOpenOptions = { wait: false }; + // TODO: remove --open-app in favor of --open-app-name const getOpenItemsFromObject = ({ target, ...rest }) => { const normalizedOptions = { ...defaultOpenOptions, ...rest }; diff --git a/lib/options.json b/lib/options.json index 5045104c08..e490cef1b1 100644 --- a/lib/options.json +++ b/lib/options.json @@ -580,7 +580,8 @@ }, { "type": "string", - "minLength": 1 + "minLength": 1, + "description": "Open specified browser. Deprecated: please use open.app.name/--open-app-name." } ], "description": "Open specified browser." diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack4 b/test/__snapshots__/validate-options.test.js.snap.webpack4 index e49a7e1813..8b78bc6655 100644 --- a/test/__snapshots__/validate-options.test.js.snap.webpack4 +++ b/test/__snapshots__/validate-options.test.js.snap.webpack4 @@ -520,7 +520,8 @@ exports[`options validate should throw an error on the "open" option with '{"app Details: * options.open.app should be an object: object { name?, arguments? } - * options.open.app should be a non-empty string." + * options.open.app should be a non-empty string. + -> Open specified browser. Deprecated: please use open.app.name/--open-app-name." `; exports[`options validate should throw an error on the "open" option with '{"foo":"bar"}' value 1`] = ` diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack5 b/test/__snapshots__/validate-options.test.js.snap.webpack5 index e49a7e1813..8b78bc6655 100644 --- a/test/__snapshots__/validate-options.test.js.snap.webpack5 +++ b/test/__snapshots__/validate-options.test.js.snap.webpack5 @@ -520,7 +520,8 @@ exports[`options validate should throw an error on the "open" option with '{"app Details: * options.open.app should be an object: object { name?, arguments? } - * options.open.app should be a non-empty string." + * options.open.app should be a non-empty string. + -> Open specified browser. Deprecated: please use open.app.name/--open-app-name." `; exports[`options validate should throw an error on the "open" option with '{"foo":"bar"}' value 1`] = ` diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack4 b/test/cli/__snapshots__/basic.test.js.snap.webpack4 index 94cbe836fd..e32c93f8a2 100644 --- a/test/cli/__snapshots__/basic.test.js.snap.webpack4 +++ b/test/cli/__snapshots__/basic.test.js.snap.webpack4 @@ -116,7 +116,7 @@ Options: --no-open Does not open the default browser. --open-target Opens specified page in browser. --open-app-name Open specified browser. - --open-app Open specified browser. + --open-app Open specified browser. Deprecated: please use open.app.name/--open-app-name. --open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). --open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser. --open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser. diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack5 b/test/cli/__snapshots__/basic.test.js.snap.webpack5 index b0520b7c07..848eca57ff 100644 --- a/test/cli/__snapshots__/basic.test.js.snap.webpack5 +++ b/test/cli/__snapshots__/basic.test.js.snap.webpack5 @@ -114,7 +114,7 @@ Options: --no-open Negative 'open' option. --open-target Opens specified page in browser. --open-app-name Open specified browser. - --open-app Open specified browser. + --open-app Open specified browser. Deprecated: please use open.app.name/--open-app-name. --open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). --open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser. --open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser. From 9cabee87d8c8992f7f090c12b3522f5709cb4c94 Mon Sep 17 00:00:00 2001 From: Nitin Kumar Date: Fri, 10 Dec 2021 06:42:32 +0530 Subject: [PATCH 2/3] docs: update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b99d4ff84..8b10be79dd 100644 --- a/README.md +++ b/README.md @@ -160,7 +160,7 @@ Options: --no-open Does not open the default browser. --open-target Opens specified page in browser. --open-app-name Open specified browser. - --open-app Open specified browser. + --open-app Open specified browser. Deprecated: please use open.app.name/--open-app-name. --open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). --open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser. --open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser. From c90a4f72285c3f6d3f509fa0edbce5fc350862ee Mon Sep 17 00:00:00 2001 From: Nitin Kumar Date: Fri, 10 Dec 2021 16:40:29 +0530 Subject: [PATCH 3/3] fix: update description --- README.md | 2 +- bin/cli-flags.js | 4 ++-- lib/options.json | 2 +- test/__snapshots__/validate-options.test.js.snap.webpack4 | 2 +- test/__snapshots__/validate-options.test.js.snap.webpack5 | 2 +- test/cli/__snapshots__/basic.test.js.snap.webpack4 | 2 +- test/cli/__snapshots__/basic.test.js.snap.webpack5 | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8b10be79dd..5c76743d61 100644 --- a/README.md +++ b/README.md @@ -160,7 +160,7 @@ Options: --no-open Does not open the default browser. --open-target Opens specified page in browser. --open-app-name Open specified browser. - --open-app Open specified browser. Deprecated: please use open.app.name/--open-app-name. + --open-app Open specified browser. Deprecated: please use '--open-app-name'. --open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). --open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser. --open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser. diff --git a/bin/cli-flags.js b/bin/cli-flags.js index 3d8d07b78b..a956878103 100644 --- a/bin/cli-flags.js +++ b/bin/cli-flags.js @@ -807,12 +807,12 @@ module.exports = { type: "string", multiple: true, description: - "Open specified browser. Deprecated: please use open.app.name/--open-app-name.", + "Open specified browser. Deprecated: please use '--open-app-name'.", path: "open[].app", }, ], description: - "Open specified browser. Deprecated: please use open.app.name/--open-app-name.", + "Open specified browser. Deprecated: please use '--open-app-name'.", simpleType: "string", multiple: true, }, diff --git a/lib/options.json b/lib/options.json index e490cef1b1..4d1649a10f 100644 --- a/lib/options.json +++ b/lib/options.json @@ -581,7 +581,7 @@ { "type": "string", "minLength": 1, - "description": "Open specified browser. Deprecated: please use open.app.name/--open-app-name." + "description": "Open specified browser. Deprecated: please use '--open-app-name'." } ], "description": "Open specified browser." diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack4 b/test/__snapshots__/validate-options.test.js.snap.webpack4 index 8b78bc6655..aec94bace2 100644 --- a/test/__snapshots__/validate-options.test.js.snap.webpack4 +++ b/test/__snapshots__/validate-options.test.js.snap.webpack4 @@ -521,7 +521,7 @@ exports[`options validate should throw an error on the "open" option with '{"app * options.open.app should be an object: object { name?, arguments? } * options.open.app should be a non-empty string. - -> Open specified browser. Deprecated: please use open.app.name/--open-app-name." + -> Open specified browser. Deprecated: please use '--open-app-name'." `; exports[`options validate should throw an error on the "open" option with '{"foo":"bar"}' value 1`] = ` diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack5 b/test/__snapshots__/validate-options.test.js.snap.webpack5 index 8b78bc6655..aec94bace2 100644 --- a/test/__snapshots__/validate-options.test.js.snap.webpack5 +++ b/test/__snapshots__/validate-options.test.js.snap.webpack5 @@ -521,7 +521,7 @@ exports[`options validate should throw an error on the "open" option with '{"app * options.open.app should be an object: object { name?, arguments? } * options.open.app should be a non-empty string. - -> Open specified browser. Deprecated: please use open.app.name/--open-app-name." + -> Open specified browser. Deprecated: please use '--open-app-name'." `; exports[`options validate should throw an error on the "open" option with '{"foo":"bar"}' value 1`] = ` diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack4 b/test/cli/__snapshots__/basic.test.js.snap.webpack4 index e32c93f8a2..7e6703c814 100644 --- a/test/cli/__snapshots__/basic.test.js.snap.webpack4 +++ b/test/cli/__snapshots__/basic.test.js.snap.webpack4 @@ -116,7 +116,7 @@ Options: --no-open Does not open the default browser. --open-target Opens specified page in browser. --open-app-name Open specified browser. - --open-app Open specified browser. Deprecated: please use open.app.name/--open-app-name. + --open-app Open specified browser. Deprecated: please use '--open-app-name'. --open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). --open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser. --open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser. diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack5 b/test/cli/__snapshots__/basic.test.js.snap.webpack5 index 848eca57ff..973c40fa6e 100644 --- a/test/cli/__snapshots__/basic.test.js.snap.webpack5 +++ b/test/cli/__snapshots__/basic.test.js.snap.webpack5 @@ -114,7 +114,7 @@ Options: --no-open Negative 'open' option. --open-target Opens specified page in browser. --open-app-name Open specified browser. - --open-app Open specified browser. Deprecated: please use open.app.name/--open-app-name. + --open-app Open specified browser. Deprecated: please use '--open-app-name'. --open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). --open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser. --open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser.