refactor!: remove the --open-app cli option (#4681)

Author: snitin315

lib/Server.js

@@ -1244,7 +1244,6 @@ class Server {
  * @param {any} target
  * @returns {NormalizedOpen[]}
  */
- // TODO: remove --open-app in favor of --open-app-name
  const getOpenItemsFromObject = ({ target, ...rest }) => {
  const normalizedOptions = { ...defaultOpenOptions, ...rest };
 
@@ -2557,7 +2556,7 @@ class Server {
  : ""
  }`
  : ""
- }. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app".`
+ }. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app-name".`
  );
  });
  })

lib/options.json

@@ -467,7 +467,7 @@
  "minLength": 1,
  "description": "Open specified browser.",
  "cli": {
- "description": "Open specified browser. Deprecated: please use '--open-app-name'."
+ "exclude": true
  }
  }
  ],

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

@@ -98,7 +98,6 @@ Options:
  --no-open Does not open the default browser.
  --open-target <value...> Opens specified page in browser.
  --open-app-name <value...> Open specified browser.
- --open-app <value...> 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.

test/cli/open-option.test.js

@@ -75,17 +75,6 @@ describe('"open" CLI option', () => {
  expect(exitCode).toEqual(0);
  });
 
- it('should work using "--open-app google-chrome"', async () => {
- const { exitCode } = await testBin([
- "--port",
- port,
- "--open-app",
- "google-chrome",
- ]);
-
- expect(exitCode).toEqual(0);
- });
-
  it('should work using "--open-app-name google-chrome"', async () => {
  const { exitCode } = await testBin([
  "--port",
@@ -144,19 +133,6 @@ describe('"open" CLI option', () => {
  expect(exitCode).toEqual(0);
  });
 
- it('should work using "--open-target /index.html --open-app google-chrome"', async () => {
- const { exitCode } = await testBin([
- "--port",
- port,
- "--open-target",
- "/index.html",
- "--open-app",
- "google-chrome",
- ]);
-
- expect(exitCode).toEqual(0);
- });
-
  it('should work using "--open-target /index.html --open-app-name google-chrome"', async () => {
  const { exitCode } = await testBin([
  "--port",
@@ -169,19 +145,4 @@ describe('"open" CLI option', () => {
 
  expect(exitCode).toEqual(0);
  });
-
- it('should work using "--open-target /index.html --open-app google-chrome --open-app-name google-chrome"', async () => {
- const { exitCode } = await testBin([
- "--port",
- port,
- "--open-target",
- "/index.html",
- "--open-app",
- "google-chrome",
- "--open-app-name",
- "google-chrome",
- ]);
-
- expect(exitCode).toEqual(0);
- });
 });

test/server/open-option.test.js

@@ -747,7 +747,7 @@ describe('"open" option', () => {
  wait: false,
  });
  expect(loggerWarnSpy).toHaveBeenCalledWith(
- `Unable to open "http://localhost:${port}/" page. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app".`
+ `Unable to open "http://localhost:${port}/" page. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app-name".`
  );
 
  getInfrastructureLoggerSpy.mockRestore();
@@ -783,7 +783,7 @@ describe('"open" option', () => {
  wait: false,
  });
  expect(loggerWarnSpy).toHaveBeenCalledWith(
- `Unable to open "http://localhost:${port}/index.html" page. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app".`
+ `Unable to open "http://localhost:${port}/index.html" page. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app-name".`
  );
 
  getInfrastructureLoggerSpy.mockRestore();
@@ -823,7 +823,7 @@ describe('"open" option', () => {
  wait: false,
  });
  expect(loggerWarnSpy).toHaveBeenCalledWith(
- `Unable to open "http://localhost:${port}/index.html" page in "google-chrome" app. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app".`
+ `Unable to open "http://localhost:${port}/index.html" page in "google-chrome" app. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app-name".`
  );
 
  loggerWarnSpy.mockRestore();
@@ -869,7 +869,7 @@ describe('"open" option', () => {
  wait: false,
  });
  expect(loggerWarnSpy).toHaveBeenCalledWith(
- `Unable to open "http://localhost:${port}/index.html" page in "google-chrome" app with "--incognito --new-window" arguments. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app".`
+ `Unable to open "http://localhost:${port}/index.html" page in "google-chrome" app with "--incognito --new-window" arguments. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app-name".`
  );
 
  getInfrastructureLoggerSpy.mockRestore();
@@ -931,11 +931,11 @@ describe('"open" option', () => {
  );
  expect(loggerWarnSpy).toHaveBeenNthCalledWith(
  1,
- `Unable to open "http://localhost:${port}/first.html" page in "google-chrome" app with "--incognito --new-window" arguments. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app".`
+ `Unable to open "http://localhost:${port}/first.html" page in "google-chrome" app with "--incognito --new-window" arguments. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app-name".`
  );
  expect(loggerWarnSpy).toHaveBeenNthCalledWith(
  2,
- `Unable to open "http://localhost:${port}/second.html" page in "google-chrome" app with "--incognito --new-window" arguments. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app".`
+ `Unable to open "http://localhost:${port}/second.html" page in "google-chrome" app with "--incognito --new-window" arguments. If you are running in a headless environment, please do not use the "open" option or related flags like "--open", "--open-target", and "--open-app-name".`
  );
 
  getInfrastructureLoggerSpy.mockRestore();

types/lib/Server.d.ts

@@ -2268,7 +2268,7 @@ declare class Server {
  minLength: number;
  description: string;
  cli: {
- description: string;
+ exclude: boolean;
  };
  additionalProperties?: undefined;
  properties?: undefined;
@@ -2329,14 +2329,17 @@ declare class Server {
  }
  )[];
  };
+ /**
+ * @type {string[]}
+ */
  }
  )[];
  description: string;
  link: string;
  };
  Server: {
  anyOf: {
- $ref: string;
+ $ref: string /** @type {ClientConfiguration} */;
  }[];
  link: string;
  description: string;
@@ -2353,7 +2356,6 @@ declare class Server {
  ServerString: {
  type: string;
  minLength: number;
- /** @type {ServerConfiguration} */
  cli: {
  exclude: boolean;
  };
@@ -2416,11 +2418,12 @@ declare class Server {
  items?: undefined;
  }
  )[];
- description: string /** @type {number | string} */;
+ description: string;
  };
  cert: {
  anyOf: (
  | {
+ /** @type {number | string} */
  type: string;
  items: {
  anyOf: (
@@ -2503,7 +2506,7 @@ declare class Server {
  }
  )[];
  };
- /** @type {ClientConfiguration} */ instanceof?: undefined;
+ instanceof?: undefined;
  }
  | {
  type: string;
@@ -2586,6 +2589,10 @@ declare class Server {
  }
  | {
  type: string;
+ /**
+ * @private
+ * @returns {Compiler["options"]}
+ */
  cli: {
  negatedDescription: string;
  };
@@ -2599,7 +2606,7 @@ declare class Server {
  cli?: undefined;
  }
  )[];
- description: string;
+ /** @type {MultiCompiler} */ description: string;
  link: string;
  };
  StaticObject: {