Skip to content

Commit

Permalink
fix: update negated descriptions for client.overlay options
Browse files Browse the repository at this point in the history
  • Loading branch information
@snitin315
snitin315 committed Feb 16, 2022
1 parent fcf8e8e commit 5120d69
Show file tree
Hide file tree
Showing 6 changed files with 243 additions and 174 deletions.
6 changes: 5 additions & 1 deletion bin/cli-flags.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ module.exports = {
description:
"Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
negatedDescription:
"Disables a full-screen overlay in the browser when there are compiler errors or warnings.",
"Disables the full-screen overlay in the browser when there are compiler errors or warnings.",
path: "client.overlay",
},
],
Expand All @@ -111,6 +111,8 @@ module.exports = {
multiple: false,
description:
"Enables a full-screen overlay in the browser when there are compiler errors.",
negatedDescription:
"Disables the full-screen overlay in the browser when there are compiler errors.",
path: "client.overlay.errors",
},
],
Expand All @@ -126,6 +128,8 @@ module.exports = {
multiple: false,
description:
"Enables a full-screen overlay in the browser when there are compiler warnings.",
negatedDescription:
"Disables the full-screen overlay in the browser when there are compiler warnings.",
path: "client.overlay.warnings",
},
],
Expand Down
12 changes: 9 additions & 3 deletions lib/options.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
"link": "https://webpack.js.org/configuration/dev-server/#overlay",
"type": "boolean",
"cli": {
"negatedDescription": "Disables a full-screen overlay in the browser when there are compiler errors or warnings."
"negatedDescription": "Disables the full-screen overlay in the browser when there are compiler errors or warnings."
}
},
{
Expand All @@ -99,11 +99,17 @@
"properties": {
"errors": {
"description": "Enables a full-screen overlay in the browser when there are compiler errors.",
"type": "boolean"
"type": "boolean",
"cli": {
"negatedDescription": "Disables the full-screen overlay in the browser when there are compiler errors."
}
},
"warnings": {
"description": "Enables a full-screen overlay in the browser when there are compiler warnings.",
"type": "boolean"
"type": "boolean",
"cli": {
"negatedDescription": "Disables the full-screen overlay in the browser when there are compiler warnings."
}
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions test/cli/__snapshots__/basic.test.js.snap.webpack4
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ Options:
--no-client Disables client script.
--client-logging <value> Allows to set log level in the browser.
--client-overlay Enables a full-screen overlay in the browser when there are compiler errors or warnings.
--no-client-overlay Disables a full-screen overlay in the browser when there are compiler errors or warnings.
--no-client-overlay Disables the full-screen overlay in the browser when there are compiler errors or warnings.
--client-overlay-errors Enables a full-screen overlay in the browser when there are compiler errors.
--no-client-overlay-errors Negative 'client-overlay-errors' option.
--no-client-overlay-errors Disables the full-screen overlay in the browser when there are compiler errors.
--client-overlay-warnings Enables a full-screen overlay in the browser when there are compiler warnings.
--no-client-overlay-warnings Negative 'client-overlay-warnings' option.
--no-client-overlay-warnings Disables the full-screen overlay in the browser when there are compiler warnings.
--client-progress Prints compilation progress in percentage in the browser.
--no-client-progress Does not print compilation progress in percentage in the browser.
--client-reconnect [value] Tells dev-server the number of times it should try to reconnect the client.
Expand Down
6 changes: 3 additions & 3 deletions test/cli/__snapshots__/basic.test.js.snap.webpack5
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ Options:
--no-client Disables client script.
--client-logging <value> Allows to set log level in the browser.
--client-overlay Enables a full-screen overlay in the browser when there are compiler errors or warnings.
--no-client-overlay Disables a full-screen overlay in the browser when there are compiler errors or warnings.
--no-client-overlay Disables the full-screen overlay in the browser when there are compiler errors or warnings.
--client-overlay-errors Enables a full-screen overlay in the browser when there are compiler errors.
--no-client-overlay-errors Negative 'client-overlay-errors' option.
--no-client-overlay-errors Disables the full-screen overlay in the browser when there are compiler errors.
--client-overlay-warnings Enables a full-screen overlay in the browser when there are compiler warnings.
--no-client-overlay-warnings Negative 'client-overlay-warnings' option.
--no-client-overlay-warnings Disables the full-screen overlay in the browser when there are compiler warnings.
--client-progress Prints compilation progress in percentage in the browser.
--no-client-progress Does not print compilation progress in percentage in the browser.
--client-reconnect [value] Tells dev-server the number of times it should try to reconnect the client.
Expand Down
2 changes: 2 additions & 0 deletions types/bin/cli-flags.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ declare const _exports: {
type: string;
multiple: boolean;
description: string;
negatedDescription: string;
path: string;
}[];
description: string;
Expand All @@ -95,6 +96,7 @@ declare const _exports: {
type: string;
multiple: boolean;
description: string;
negatedDescription: string;
path: string;
}[];
description: string;
Expand Down

0 comments on commit 5120d69

Please sign in to comment.