fix: the --devtool CLI flag not work as expected (#10880)

* fix: devtool cmd line not work and default value

* feat: Change English annotation

* feat: change build value

* feat: change build value

* fix: type

* fix: change test

* docs: change doc

* Apply suggestion from @chenjiahan

* Apply suggestion from @chenjiahan

* Apply suggestion from @chenjiahan

* Apply suggestion from @chenjiahan

---------

Co-authored-by: neverland <jait.chen@foxmail.com>

Author: Meet-student

packages/rspack-cli/src/cli.ts

@@ -172,6 +172,11 @@ export class RspackCLI {
 			if (typeof item.devtool === "undefined") {
 				item.devtool = isBuild ? "source-map" : "cheap-module-source-map";
 			}
+			// The CLI flag has a higher priority than the default devtool and devtool from the config.
+			if (typeof options.devtool !== "undefined") {
+				item.devtool = options.devtool as RspackOptions["devtool"];
+			}
+
 			if (isServe) {
 				const installed = (item.plugins ||= []).find(
 					item => item instanceof rspackCore.ProgressPlugin

packages/rspack-cli/src/types.ts

@@ -30,7 +30,7 @@ export interface RspackCLIOptions {
 
 export interface RspackBuildCLIOptions extends RspackCLIOptions {
 	entry?: string[];
-	devtool?: boolean;
+	devtool?: string | boolean;
 	mode?: string;
 	watch?: boolean;
 	analyze?: boolean;

packages/rspack-cli/src/utils/options.ts

@@ -58,10 +58,15 @@ export const commonOptionsForBuildAndServe = (yargs: yargs.Argv) => {
 				describe: "env passed to config function"
 			},
 			devtool: {
-				type: "boolean",
-				default: false,
-				describe: "devtool",
-				alias: "d"
+				type: "string",
+				describe:
+					"Specify a developer tool for debugging. Defaults to `cheap-module-source-map` in development and `source-map` in production.",
+				alias: "d",
+				coerce: (arg): string | boolean => {
+					if (arg === "true") return "source-map";
+					if (arg === "false" || arg.trim() === "") return false;
+					return arg;
+				}
 			}
 		})
 		.alias({ v: "version", h: "help" });

packages/rspack-cli/tests/build/basic/basic.test.ts

@@ -116,14 +116,23 @@ describe("build command", () => {
 		}
 	);
 
-	it.each(["-d", "--devtool"])(
+	it.each([
+		["-d", "eval-source-map"],
+		["--devtool", "eval-source-map"],
+		["-d", ""],
+		["--devtool", ""],
+		["-d", "false"],
+		["--devtool", "false"]
+	])(
 		"devtool option %p should have higher priority than config",
-		async command => {
+		async (command, option) => {
 			const { exitCode, stderr, stdout } = await run(__dirname, [
 				command,
+				option,
 				"--config",
 				"./entry.config.js"
 			]);
+
 			const mainJs = await readFile(
 				resolve(__dirname, "dist/public/main.js"),
 				"utf-8"

website/docs/en/config/devtool.mdx

@@ -14,7 +14,7 @@ Use the [SourceMapDevToolPlugin](/plugins/webpack/source-map-dev-tool-plugin) or
 type Devtool = 'string' | false;
 ```
 
-- **Default:** `eval`
+- **Default:** `cheap-module-source-map` in development mode and `source-map` in production mode
 
 ## Configuration guide
 

website/docs/zh/config/devtool.mdx

@@ -14,7 +14,7 @@ import WebpackLicense from '@components/WebpackLicense';
 type Devtool = 'string' | false;
 ```
 
-- **默认值：** `eval`
+- **默认值：** development 模式为 `cheap-module-source-map`，production 模式 为 `source-map`
 
 ## 决策指南