Skip to content

fix(sourceMap): use absolute paths in dev for VS Code debugging #6492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 1 commit into from
Nov 3, 2025
Merged

fix(sourceMap): use absolute paths in dev for VS Code debugging #6492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/compat/webpack/tests/__snapshots__/default.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly 1`] = `
"output": {
"assetModuleFilename": "static/assets/[name].[contenthash:8][ext]",
"chunkFilename": "static/js/async/[name].js",
"devtoolModuleFilenameTemplate": "[absolute-resource-path]",
"devtoolModuleFilenameTemplate": [Function],
"filename": "static/js/[name].js",
"hashFunction": "xxhash64",
"path": "<ROOT>/packages/compat/webpack/tests/dist",
Expand Down
23 changes: 16 additions & 7 deletions packages/core/src/plugins/sourceMap.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,22 @@ export const pluginSourceMap = (): RsbuildPlugin => ({
return typeof sourceMap === 'object' && sourceMap.css;
};

api.modifyBundlerChain((chain, { bundler, environment }) => {
api.modifyBundlerChain((chain, { bundler, environment, isDev, target }) => {
const { config } = environment;
const devtool = getDevtool(config);

chain
.devtool(devtool)
.output.devtoolModuleFilenameTemplate(DEFAULT_SOURCE_MAP_TEMPLATE);
const devtool = getDevtool(config);
chain.devtool(devtool);

if (isDev && target === 'web') {
// Use POSIX-style absolute paths in source maps during development
// This ensures VS Code and browser debuggers can correctly resolve breakpoints
chain.output.devtoolModuleFilenameTemplate(
(info: { absoluteResourcePath: string }) =>
toPosixPath(info.absoluteResourcePath),
);
} else {
chain.output.devtoolModuleFilenameTemplate(DEFAULT_SOURCE_MAP_TEMPLATE);
}

// When JS source map is disabled, but CSS source map is enabled,
// add `SourceMapDevToolPlugin` to let Rspack generate CSS source map.
Expand Down Expand Up @@ -69,8 +78,8 @@ export const pluginSourceMap = (): RsbuildPlugin => ({
return;
}

// If devtoolModuleFilenameTemplate is not the default template,
// which means users want to customize it, skip the default processing.
// If devtoolModuleFilenameTemplate is not the default absolute path template,
// we do not need to convert it to relative path.
if (
compilation.outputOptions.devtoolModuleFilenameTemplate !==
DEFAULT_SOURCE_MAP_TEMPLATE
Expand Down
2 changes: 1 addition & 1 deletion packages/core/tests/__snapshots__/builder.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ exports[`should use Rspack as the default bundler > apply Rspack correctly 1`] =
"output": {
"assetModuleFilename": "static/assets/[name].[contenthash:8][ext]",
"chunkFilename": "static/js/async/[name].js",
"devtoolModuleFilenameTemplate": "[absolute-resource-path]",
"devtoolModuleFilenameTemplate": [Function],
"filename": "static/js/[name].js",
"hashFunction": "xxhash64",
"path": "<ROOT>/dist",
Expand Down
4 changes: 2 additions & 2 deletions packages/core/tests/__snapshots__/default.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly 1`] = `
"output": {
"assetModuleFilename": "static/assets/[name].[contenthash:8][ext]",
"chunkFilename": "static/js/async/[name].js",
"devtoolModuleFilenameTemplate": "[absolute-resource-path]",
"devtoolModuleFilenameTemplate": [Function],
"filename": "static/js/[name].js",
"hashFunction": "xxhash64",
"path": "<ROOT>/packages/core/tests/dist",
Expand Down Expand Up @@ -1927,7 +1927,7 @@ exports[`tools.rspack > should match snapshot 1`] = `
"output": {
"assetModuleFilename": "static/assets/[name].[contenthash:8][ext]",
"chunkFilename": "static/js/async/[name].js",
"devtoolModuleFilenameTemplate": "[absolute-resource-path]",
"devtoolModuleFilenameTemplate": [Function],
"filename": "static/js/[name].js",
"hashFunction": "xxhash64",
"path": "<ROOT>/packages/core/tests/dist",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/tests/__snapshots__/environments.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1836,7 +1836,7 @@ exports[`environment config > tools.rspack / bundlerChain can be configured in e
"output": {
"assetModuleFilename": "static/assets/[name].[contenthash:8][ext]",
"chunkFilename": "static/js/async/[name].js",
"devtoolModuleFilenameTemplate": "[absolute-resource-path]",
"devtoolModuleFilenameTemplate": [Function],
"filename": "static/js/[name].js",
"hashFunction": "xxhash64",
"path": "<ROOT>/dist",
Expand Down
Loading