chore: update commander.js to v12 (#4315)

webpack · Dec 17, 2024 · 540d501 · 540d501
1 parent 59e9117
commit 540d501
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 16 deletions.
diff --git a/packages/webpack-cli/package.json b/packages/webpack-cli/package.json
@@ -39,7 +39,7 @@
     "@webpack-cli/info": "^2.0.2",
     "@webpack-cli/serve": "^2.0.5",
     "colorette": "^2.0.14",
-    "commander": "^10.0.1",
+    "commander": "^12.1.0",
     "cross-spawn": "^7.0.3",
     "envinfo": "^7.14.0",
     "fastest-levenshtein": "^1.0.12",

diff --git a/packages/webpack-cli/src/webpack-cli.ts b/packages/webpack-cli/src/webpack-cli.ts
@@ -1669,7 +1669,8 @@ class WebpackCLI implements IWebpackCLI {
       process.exit(0);
     };
     this.program.helpOption(false);
-    this.program.addHelpCommand(false);
+    // Suppress the default help command
+    this.program.helpCommand(false);
     this.program.option("-h, --help [verbose]", "Display help for commands and options.");
 
     let isInternalActionCalled = false;

diff --git a/test/api/CLI.test.js b/test/api/CLI.test.js
@@ -1703,11 +1703,9 @@ describe("CLI API", () => {
       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" });
+          cli.run(["help", "--mode"], { from: "user" });
           resolve();
         } catch (error) {
           reject(error);

diff --git a/test/api/__snapshots__/CLI.test.js.snap.webpack5 b/test/api/__snapshots__/CLI.test.js.snap.webpack5
@@ -3,13 +3,13 @@
 exports[`CLI API custom help output should display help information 1`] = `
 [
   [
-    "[1mUsage[22m: webpack --color [value]",
+    "Usage: webpack --mode <value>",
   ],
   [
-    "[1mDescription:[22m any color",
+    "Description: Enable production optimizations or development hints.",
   ],
   [
-    "[1mDefault value:[22m "blue"",
+    "Possible values: "development | production | none"",
   ],
   [
     "",
@@ -19,13 +19,13 @@ exports[`CLI API custom help output should display help information 1`] = `
 ",
   ],
   [
-    "[1mWebpack documentation:[22m https://webpack.js.org/.",
+    "Webpack documentation: https://webpack.js.org/.",
   ],
   [
-    "[1mCLI documentation:[22m https://webpack.js.org/api/cli/.",
+    "CLI documentation: https://webpack.js.org/api/cli/.",
   ],
   [
-    "[1mMade with ♥ by the webpack team[22m.",
+    "Made with ♥ by the webpack team.",
   ],
 ]
 `;
diff --git a/yarn.lock b/yarn.lock
@@ -4142,11 +4142,6 @@ combined-stream@^1.0.8:
   dependencies:
     delayed-stream "~1.0.0"
 
-commander@^10.0.1:
-  version "10.0.1"
-  resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.1.tgz#881ee46b4f77d1c1dccc5823433aa39b022cbe06"
-  integrity sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==
-
 commander@^12.1.0, commander@~12.1.0:
   version "12.1.0"
   resolved "https://registry.yarnpkg.com/commander/-/commander-12.1.0.tgz#01423b36f501259fdaac4d0e4d60c96c991585d3"