feat!: change default value for devtool (#12934)

SyMind · web-flow · commit 0f5a0bd1184c · 2026-02-04T14:02:29.000+08:00
diff --git a/packages/rspack-cli/src/cli.ts b/packages/rspack-cli/src/cli.ts
@@ -162,7 +162,7 @@ export class RspackCLI {
 
       // false is also a valid value for sourcemap, so don't override it
       if (typeof item.devtool === 'undefined') {
-        item.devtool = isBuild ? 'source-map' : 'cheap-module-source-map';
+        item.devtool = isBuild ? false : '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') {
diff --git a/packages/rspack/src/config/defaults.ts b/packages/rspack/src/config/defaults.ts
@@ -81,7 +81,10 @@ export const applyRspackOptionsDefaults = (
     }
   }
 
-  F(options, 'devtool', () => (development ? 'eval' : false));
+  // IGNORE(devtool): Rspack use cheap-module-source-map by default
+  F(options, 'devtool', () =>
+    development ? 'cheap-module-source-map' : false,
+  );
   D(options, 'watch', false);
   // IGNORE(lazyCompilation): Unlike webpack where lazyCompilation is configured under experiments, Rspack exposes this option at the configuration root level.
   D(options, 'lazyCompilation', false);
diff --git a/tests/e2e/cases/hooks/asset-emitted/index.test.ts b/tests/e2e/cases/hooks/asset-emitted/index.test.ts
@@ -15,7 +15,7 @@ test('asset emitted hook should only emit modified assets', async ({
     return content.replace('__ROOT_TEXT__', '__OTHER_TEXT__');
   });
   await expect(page.locator('#root')).toHaveText('__OTHER_TEXT____FOO_VALUE__');
-  expect(assets).toEqual(['main.js']);
+  expect(assets.sort()).toEqual(['main.js', 'main.js.map']);
 
   // reset assets
   assets.length = 0;
@@ -26,7 +26,12 @@ test('asset emitted hook should only emit modified assets', async ({
   });
   await expect(page.locator('#root')).toHaveText('__OTHER_TEXT____VALUE__');
   // main.js contains runtime module, so it should also emit
-  expect(assets.sort()).toEqual(['main.js', 'src_foo_js.js']);
+  expect(assets.sort()).toEqual([
+    'main.js',
+    'main.js.map',
+    'src_foo_js.js',
+    'src_foo_js.js.map',
+  ]);
 
   // check dist dir
   // the outputFileSystem can contain only one main hot-update.js
@@ -53,7 +58,7 @@ test('asset emitted should not emit removed assets', async ({
     return 'document.getElementById("root").innerText = "__ROOT_TEXT__"';
   });
   await expect(page.locator('#root')).toHaveText('__ROOT_TEXT__');
-  expect(assets).toEqual(['main.js']);
+  expect(assets.sort()).toEqual(['main.js', 'main.js.map']);
 
   // check dist dir
   const files = rspack.compiler.outputFileSystem.readdirSync(
diff --git a/tests/rspack-test/compilerCases/banner-plugin.js b/tests/rspack-test/compilerCases/banner-plugin.js
@@ -55,6 +55,7 @@ module.exports = [{
   options(context) {
     return {
       mode: "development",
+      devtool: 'eval',
       entry: {
         footerFile: context.getDist("footerFile.js")
       },
diff --git a/tests/rspack-test/defaultsCases/cache/cache-filesystem-dev.js b/tests/rspack-test/defaultsCases/cache/cache-filesystem-dev.js
@@ -28,7 +28,7 @@ module.exports = {
 			+   },
 			@@ ... @@
 			-   "devtool": false,
-			+   "devtool": "eval",
+			+   "devtool": "cheap-module-source-map",
 			@@ ... @@
 			-   "mode": "none",
 			+   "mode": "development",
diff --git a/tests/rspack-test/defaultsCases/mode/development.js b/tests/rspack-test/defaultsCases/mode/development.js
@@ -12,7 +12,7 @@ module.exports = {
 			+   "cache": true,
 			@@ ... @@
 			-   "devtool": false,
-			+   "devtool": "eval",
+			+   "devtool": "cheap-module-source-map",
 			@@ ... @@
 			-   "mode": "none",
 			+   "mode": "development",
diff --git a/tests/rspack-test/statsOutputCases/all-stats/rspack.config.js b/tests/rspack-test/statsOutputCases/all-stats/rspack.config.js
@@ -1,6 +1,7 @@
 /** @type {import("@rspack/core").Configuration} */
 module.exports = {
 	mode: "development",
+	devtool: 'eval',
 	entry: "./index.js",
 	output: {
 		filename: "bundle.js"
diff --git a/tests/rspack-test/statsOutputCases/immutable/rspack.config.js b/tests/rspack-test/statsOutputCases/immutable/rspack.config.js
@@ -1,6 +1,7 @@
 /** @type {import("@rspack/core").Configuration} */
 module.exports = {
 	mode: "development",
+	devtool: 'eval',
 	entry: "./index.js",
 	output: {
 		filename: "[contenthash].js"
diff --git a/tests/rspack-test/statsOutputCases/performance-different-mode-and-target/rspack.config.js b/tests/rspack-test/statsOutputCases/performance-different-mode-and-target/rspack.config.js
@@ -39,6 +39,7 @@ module.exports = [
 	{
 		entry: "./index",
 		mode: "development",
+		devtool: 'eval',
 		target: "web",
 		output: {
 			filename: "no-warning.dev-web.js"
@@ -51,6 +52,7 @@ module.exports = [
 	{
 		entry: "./index",
 		mode: "development",
+		devtool: 'eval',
 		target: "node",
 		output: {
 			filename: "no-warning.dev-node.js"
@@ -63,6 +65,7 @@ module.exports = [
 	{
 		entry: "./index",
 		mode: "development",
+		devtool: 'eval',
 		target: "web",
 		performance: {
 			maxAssetSize: 100
diff --git a/tests/rspack-test/statsOutputCases/resolve-unexpected-exports-in-pkg-error/rspack.config.js b/tests/rspack-test/statsOutputCases/resolve-unexpected-exports-in-pkg-error/rspack.config.js
@@ -1,6 +1,7 @@
 module.exports = {
     entry: './index.js',
     mode: 'development',
+    devtool: 'eval',
     stats: {
         assets: true,
         modules: true,
diff --git a/tests/rspack-test/statsOutputCases/split-chunks-max-size/rspack.config.js b/tests/rspack-test/statsOutputCases/split-chunks-max-size/rspack.config.js
@@ -32,6 +32,7 @@ module.exports = [
 	{
 		name: "development",
 		mode: "development",
+		devtool: 'eval',
 		entry: {
 			main: "./"
 		},
diff --git a/website/docs/en/config/devtool.mdx b/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:** `cheap-module-source-map` in development mode and `source-map` in production mode
+- **Default:** `cheap-module-source-map` in development mode and `false` in production mode
 
 ## Configuration guide
 
@@ -69,13 +69,9 @@ We expect a certain pattern when validate devtool name, pay attention and don't
 
 The following options are ideal for development:
 
-`eval` - Each module is executed with `eval()` and `//# sourceURL`. This is pretty fast. The main disadvantage is that it doesn't display line numbers correctly since it gets mapped to transpiled code instead of the original code (No source maps from Loaders).
+`cheap-source-map` - A source map is emitted as a separate file, it is "cheap" because it doesn't have column mappings, it only maps line numbers. It ignores source maps from Loaders and only display transpiled code similar to the eval devtool.
 
-`eval-source-map` - Each module is executed with `eval()` and a source map is added as a DataUrl to the `eval()`. Initially it is slow, but it provides fast rebuild speed and yields real files. Line numbers are correctly mapped since it gets mapped to the original code. It yields the best quality source maps for development.
-
-`eval-cheap-source-map` - Similar to `eval-source-map`, each module is executed with `eval()`. It is "cheap" because it doesn't have column mappings, it only maps line numbers. It ignores source maps from Loaders and only display transpiled code similar to the eval devtool.
-
-`eval-cheap-module-source-map` - Similar to `eval-cheap-source-map`, however, in this case source maps from Loaders are processed for better results. However Loader source maps are simplified to a single mapping per line.
+`cheap-module-source-map` - Similar to `cheap-source-map`, however, in this case source maps from Loaders are processed for better results. However Loader source maps are simplified to a single mapping per line.
 
 ### Production
 
diff --git a/website/docs/zh/config/devtool.mdx b/website/docs/zh/config/devtool.mdx
@@ -14,7 +14,7 @@ import WebpackLicense from '@components/WebpackLicense';
 type Devtool = 'string' | false;
 ```
 
-- **默认值：** development 模式为 `cheap-module-source-map`，production 模式 为 `source-map`
+- **默认值：** development 模式为 `cheap-module-source-map`，production 模式 为 `false`
 
 ## 决策指南
 
@@ -69,13 +69,9 @@ type Devtool = 'string' | false;
 
 以下选项非常适合开发环境：
 
-`eval` - 每个模块都使用 `eval()` 执行，并且都有 `//# sourceURL`。优点是构建性能极快，缺点是，不会映射到源代码。
+`cheap-source-map` - source map 作为一个单独的文件生成，不计算列映射，只是映射行。忽略源自 loader 的 source map，仅映射到转译后的代码。
 
-`eval-source-map` - 每个模块使用 `eval()` 执行，并且将模块 source map 转换为 DataUrl 后添加到 `eval()` 中，避免 chunk 级 source map 合并计算。
-
-`eval-cheap-source-map` - 类似 `eval-source-map`，每个模块使用 `eval()` 执行。source map 不计算列映射，只是映射行。忽略源自 loader 的 source map，仅映射到转译后的代码。
-
-`eval-cheap-module-source-map` - 类似 `eval-cheap-source-map`，并且，但会处理源自 loader 的 source map，映射到源代码。然而，source map 不计算列映射，只是映射行。
+`cheap-module-source-map` - 类似 `cheap-source-map`，并且，但会处理源自 loader 的 source map，映射到源代码。然而，source map 不计算列映射，只是映射行。
 
 ### 生产环境
 

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ export class RspackCLI {`
`162`	`162`
`163`	`163`	`// false is also a valid value for sourcemap, so don't override it`
`164`	`164`	`if (typeof item.devtool === 'undefined') {`
`165`		`- item.devtool = isBuild ? 'source-map' : 'cheap-module-source-map';`
	`165`	`+ item.devtool = isBuild ? false : 'cheap-module-source-map';`
`166`	`166`	`}`
`167`	`167`	`// The CLI flag has a higher priority than the default devtool and devtool from the config.`
`168`	`168`	`if (typeof options.devtool !== 'undefined') {`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,10 @@ export const applyRspackOptionsDefaults = (`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`
`84`		`- F(options, 'devtool', () => (development ? 'eval' : false));`
	`84`	`+ // IGNORE(devtool): Rspack use cheap-module-source-map by default`
	`85`	`+ F(options, 'devtool', () =>`
	`86`	`+ development ? 'cheap-module-source-map' : false,`
	`87`	`+ );`
`85`	`88`	`D(options, 'watch', false);`
`86`	`89`	`// IGNORE(lazyCompilation): Unlike webpack where lazyCompilation is configured under experiments, Rspack exposes this option at the configuration root level.`
`87`	`90`	`D(options, 'lazyCompilation', false);`