fix: show default value in help output if available (#2814)

* fix: show default value in help output if available * test: add
webpack · Jul 15, 2021 · 7f50948 · 7f50948
1 parent 0d8d832
commit 7f50948
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 1 deletion.
diff --git a/packages/webpack-cli/lib/webpack-cli.js b/packages/webpack-cli/lib/webpack-cli.js
@@ -1357,7 +1357,7 @@ class WebpackCLI {
                     this.logger.raw(`${bold("Description:")} ${option.description}`);
                 }
 
-                if (!option.negate && options.defaultValue) {
+                if (!option.negate && option.defaultValue) {
                     this.logger.raw(
                         `${bold("Default value:")} ${JSON.stringify(option.defaultValue)}`,
                     );

diff --git a/test/api/CLI.test.js b/test/api/CLI.test.js
@@ -1699,4 +1699,34 @@ describe("CLI API", () => {
             expect(command.helpInformation()).toContain("--no-boolean  Negated description");
         });
     });
+
+    describe("custom help output", () => {
+        let consoleSpy;
+        let exitSpy;
+
+        beforeEach(async () => {
+            consoleSpy = jest.spyOn(global.console, "log");
+            exitSpy = jest.spyOn(process, "exit").mockImplementation(() => {});
+
+            cli.program.option("--color [value]", "any color", "blue");
+            await new Promise((resolve, reject) => {
+                try {
+                    cli.run(["help", "--color"], { from: "user" });
+                    resolve();
+                } catch (error) {
+                    reject(error);
+                }
+            });
+        });
+
+        afterEach(async () => {
+            consoleSpy.mockRestore();
+            exitSpy.mockRestore();
+        });
+
+        it("should display help information", () => {
+            expect(exitSpy).toHaveBeenCalledWith(0);
+            expect(consoleSpy.mock.calls).toMatchSnapshot();
+        });
+    });
 });
diff --git a/test/api/__snapshots__/CLI.test.js.snap.webpack4 b/test/api/__snapshots__/CLI.test.js.snap.webpack4
@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CLI API custom help output should display help information 1`] = `
+Array [
+  Array [
+    "[1mUsage[22m: webpack --color [value]",
+  ],
+  Array [
+    "[1mDescription:[22m any color",
+  ],
+  Array [
+    "[1mDefault value:[22m \\"blue\\"",
+  ],
+  Array [
+    "",
+  ],
+  Array [
+    "To see list of all supported commands and options run 'webpack --help=verbose'.
+",
+  ],
+  Array [
+    "[1mWebpack documentation:[22m https://webpack.js.org/.",
+  ],
+  Array [
+    "[1mCLI documentation:[22m https://webpack.js.org/api/cli/.",
+  ],
+  Array [
+    "[1mMade with ♥ by the webpack team[22m.",
+  ],
+]
+`;
diff --git a/test/api/__snapshots__/CLI.test.js.snap.webpack5 b/test/api/__snapshots__/CLI.test.js.snap.webpack5
@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CLI API custom help output should display help information 1`] = `
+Array [
+  Array [
+    "[1mUsage[22m: webpack --color [value]",
+  ],
+  Array [
+    "[1mDescription:[22m any color",
+  ],
+  Array [
+    "[1mDefault value:[22m \\"blue\\"",
+  ],
+  Array [
+    "",
+  ],
+  Array [
+    "To see list of all supported commands and options run 'webpack --help=verbose'.
+",
+  ],
+  Array [
+    "[1mWebpack documentation:[22m https://webpack.js.org/.",
+  ],
+  Array [
+    "[1mCLI documentation:[22m https://webpack.js.org/api/cli/.",
+  ],
+  Array [
+    "[1mMade with ♥ by the webpack team[22m.",
+  ],
+]
+`;