From deb83bd58c3bc14d158aa549233df03d188cbf32 Mon Sep 17 00:00:00 2001 From: Nitin Kumar Date: Fri, 10 Dec 2021 06:38:27 +0530 Subject: [PATCH] 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 8cde80e212..75d30e2e28 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 61c91a3642..0858321e48 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 cf2e0defda..350c51a99b 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 cf2e0defda..350c51a99b 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 75f870515d..648b9ec1c8 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 bb11c322eb..cbc856b953 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.