Skip to content

Commit 828e5c9

Browse files
snitin315snitin315
authoredJul 7, 2021
feat: show possible values for option in help output (#2819)
* feat: show possible values for option in help output * fix: show all possible values * test: updates * test: update snaps * test: fix * test: fix
·
webpack-cli@6.0.1create-new-webpack-app@1.1.0
1 parent 49554a7 commit 828e5c9

File tree

4 files changed

+73
-2
lines changed

4 files changed

+73
-2
lines changed
 

‎packages/webpack-cli/lib/webpack-cli.js

+22-1
Original file line numberDiff line numberDiff line change
@@ -1363,10 +1363,31 @@ class WebpackCLI {
13631363
);
13641364
}
13651365

1366+
const flag = this.getBuiltInOptions().find(
1367+
(flag) => option.long === `--${flag.name}`,
1368+
);
1369+
1370+
if (flag && flag.configs) {
1371+
const possibleValues = flag.configs.reduce((accumulator, currentValue) => {
1372+
if (currentValue.values) {
1373+
return accumulator.concat(currentValue.values);
1374+
} else {
1375+
return accumulator;
1376+
}
1377+
}, []);
1378+
1379+
if (possibleValues.length > 0) {
1380+
this.logger.raw(
1381+
`${bold("Possible values:")} ${JSON.stringify(
1382+
possibleValues.join(" | "),
1383+
)}`,
1384+
);
1385+
}
1386+
}
1387+
13661388
this.logger.raw("");
13671389

13681390
// TODO implement this after refactor cli arguments
1369-
// logger.raw('Possible values: foo | bar');
13701391
// logger.raw('Documentation: https://webpack.js.org/option/name/');
13711392
} else {
13721393
outputIncorrectUsageOfHelp();

‎test/help/__snapshots__/help.test.js.snap.devServer3.webpack5

+19
Original file line numberDiff line numberDiff line change
@@ -2540,6 +2540,20 @@ CLI documentation: https://webpack.js.org/api/cli/.
25402540
Made with ♥ by the webpack team."
25412541
`;
25422542

2543+
exports[`help should show help information using the "help --cache-type" option: stderr 1`] = `""`;
2544+
2545+
exports[`help should show help information using the "help --cache-type" option: stdout 1`] = `
2546+
"Usage: webpack --cache-type <value>
2547+
Description: In memory caching. Filesystem caching.
2548+
Possible values: \\"memory | filesystem\\"
2549+
2550+
To see list of all supported commands and options run 'webpack --help=verbose'.
2551+
2552+
Webpack documentation: https://webpack.js.org/.
2553+
CLI documentation: https://webpack.js.org/api/cli/.
2554+
Made with ♥ by the webpack team."
2555+
`;
2556+
25432557
exports[`help should show help information using the "help --color" option: stderr 1`] = `""`;
25442558

25452559
exports[`help should show help information using the "help --color" option: stdout 1`] = `
@@ -2560,6 +2574,7 @@ exports[`help should show help information using the "help --mode" option: stder
25602574
exports[`help should show help information using the "help --mode" option: stdout 1`] = `
25612575
"Usage: webpack --mode <value>
25622576
Description: Defines the mode to pass to webpack.
2577+
Possible values: \\"development | production | none\\"
25632578

25642579
To see list of all supported commands and options run 'webpack --help=verbose'.
25652580

@@ -2571,6 +2586,7 @@ Made with ♥ by the webpack team."
25712586
exports[`help should show help information using the "help --mode" option: stdout 2`] = `
25722587
"Usage: webpack --mode <value>
25732588
Description: Defines the mode to pass to webpack.
2589+
Possible values: \\"development | production | none\\"
25742590

25752591
To see list of all supported commands and options run 'webpack --help=verbose'.
25762592

@@ -2610,6 +2626,7 @@ exports[`help should show help information using the "help --stats" option: stde
26102626
exports[`help should show help information using the "help --stats" option: stdout 1`] = `
26112627
"Usage: webpack --stats [value]
26122628
Description: It instructs webpack on how to treat the stats e.g. verbose.
2629+
Possible values: \\"none | summary | errors-only | errors-warnings | minimal | normal | detailed | verbose\\"
26132630

26142631
To see list of all supported commands and options run 'webpack --help=verbose'.
26152632

@@ -2624,6 +2641,7 @@ exports[`help should show help information using the "help --target" option: std
26242641
"Usage: webpack --target <value...>
26252642
Short: webpack -t <value...>
26262643
Description: Sets the build target e.g. node.
2644+
Possible values: \\"false\\"
26272645

26282646
To see list of all supported commands and options run 'webpack --help=verbose'.
26292647

@@ -2678,6 +2696,7 @@ exports[`help should show help information using the "help serve --mode" option:
26782696
exports[`help should show help information using the "help serve --mode" option: stdout 1`] = `
26792697
"Usage: webpack serve --mode <value>
26802698
Description: Defines the mode to pass to webpack.
2699+
Possible values: \\"development | production | none\\"
26812700

26822701
To see list of all supported commands and options run 'webpack --help=verbose'.
26832702

‎test/help/__snapshots__/help.test.js.snap.devServer4.webpack5

+19
Original file line numberDiff line numberDiff line change
@@ -2670,6 +2670,20 @@ CLI documentation: https://webpack.js.org/api/cli/.
26702670
Made with ♥ by the webpack team."
26712671
`;
26722672

2673+
exports[`help should show help information using the "help --cache-type" option: stderr 1`] = `""`;
2674+
2675+
exports[`help should show help information using the "help --cache-type" option: stdout 1`] = `
2676+
"Usage: webpack --cache-type <value>
2677+
Description: In memory caching. Filesystem caching.
2678+
Possible values: \\"memory | filesystem\\"
2679+
2680+
To see list of all supported commands and options run 'webpack --help=verbose'.
2681+
2682+
Webpack documentation: https://webpack.js.org/.
2683+
CLI documentation: https://webpack.js.org/api/cli/.
2684+
Made with ♥ by the webpack team."
2685+
`;
2686+
26732687
exports[`help should show help information using the "help --color" option: stderr 1`] = `""`;
26742688

26752689
exports[`help should show help information using the "help --color" option: stdout 1`] = `
@@ -2690,6 +2704,7 @@ exports[`help should show help information using the "help --mode" option: stder
26902704
exports[`help should show help information using the "help --mode" option: stdout 1`] = `
26912705
"Usage: webpack --mode <value>
26922706
Description: Defines the mode to pass to webpack.
2707+
Possible values: \\"development | production | none\\"
26932708

26942709
To see list of all supported commands and options run 'webpack --help=verbose'.
26952710

@@ -2701,6 +2716,7 @@ Made with ♥ by the webpack team."
27012716
exports[`help should show help information using the "help --mode" option: stdout 2`] = `
27022717
"Usage: webpack --mode <value>
27032718
Description: Defines the mode to pass to webpack.
2719+
Possible values: \\"development | production | none\\"
27042720

27052721
To see list of all supported commands and options run 'webpack --help=verbose'.
27062722

@@ -2740,6 +2756,7 @@ exports[`help should show help information using the "help --stats" option: stde
27402756
exports[`help should show help information using the "help --stats" option: stdout 1`] = `
27412757
"Usage: webpack --stats [value]
27422758
Description: It instructs webpack on how to treat the stats e.g. verbose.
2759+
Possible values: \\"none | summary | errors-only | errors-warnings | minimal | normal | detailed | verbose\\"
27432760

27442761
To see list of all supported commands and options run 'webpack --help=verbose'.
27452762

@@ -2754,6 +2771,7 @@ exports[`help should show help information using the "help --target" option: std
27542771
"Usage: webpack --target <value...>
27552772
Short: webpack -t <value...>
27562773
Description: Sets the build target e.g. node.
2774+
Possible values: \\"false\\"
27572775

27582776
To see list of all supported commands and options run 'webpack --help=verbose'.
27592777

@@ -2808,6 +2826,7 @@ exports[`help should show help information using the "help serve --mode" option:
28082826
exports[`help should show help information using the "help serve --mode" option: stdout 1`] = `
28092827
"Usage: webpack serve --mode <value>
28102828
Description: Defines the mode to pass to webpack.
2829+
Possible values: \\"development | production | none\\"
28112830

28122831
To see list of all supported commands and options run 'webpack --help=verbose'.
28132832

‎test/help/help.test.js

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"use strict";
22

3-
const { run, normalizeStderr, normalizeStdout } = require("../utils/test-utils");
3+
const { run, normalizeStderr, normalizeStdout, isWebpack5 } = require("../utils/test-utils");
44

55
describe("help", () => {
66
it('should show help information using the "--help" option', async () => {
@@ -242,6 +242,18 @@ describe("help", () => {
242242
expect(normalizeStdout(stdout)).toMatchSnapshot("stdout");
243243
});
244244

245+
it('should show help information using the "help --cache-type" option', async () => {
246+
const { exitCode, stderr, stdout } = await run(__dirname, ["help", "--cache-type"]);
247+
248+
if (isWebpack5) {
249+
expect(exitCode).toBe(0);
250+
expect(normalizeStderr(stderr)).toMatchSnapshot("stderr");
251+
expect(normalizeStdout(stdout)).toMatchSnapshot("stdout");
252+
} else {
253+
expect(exitCode).toBe(2);
254+
}
255+
});
256+
245257
it('should show help information using the "help --no-stats" option', async () => {
246258
const { exitCode, stderr, stdout } = await run(__dirname, ["help", "--no-stats"]);
247259

0 commit comments

Comments
 (0)
Please sign in to comment.