Skip to content
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.

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

Add Source Map sourceRoot Support #1028

Merged
merged 2 commits into from Mar 25, 2021
Merged

Add Source Map sourceRoot Support #1028

merged 2 commits into from Mar 25, 2021

Conversation

jridgewell
Copy link
Contributor

@jridgewell jridgewell commented Mar 21, 2021

This adds the --source-root, sourceRoot (JS), and SourceRoot (Go) options to insert a sourceRoot field in any output source maps. When a sourceRoot exists on the map, any sources are resolved relative to it.

This is particularly useful when hosting compiled code on a server, and pointing the source files to a GitHub repo. Eg, as AMP does.

Fixes #675.

This adds the `--sourcemap-root`, `sourcemapRoot` (JS), and `SourcemapRoot` (Go) options to insert a `sourceRoot` field in any output source maps. When a `sourceRoot` exists on the map, any sources are resolved relative to it.

 This is particularly useful when hosting compiled code on a server, and pointing the source files to a GitHub repo. Eg, as [AMP does](https://cdn.ampproject.org/v0.mjs.map).
@evanw
Copy link
Owner

evanw commented Mar 24, 2021

Some thoughts:

  • I think this should be sourceRoot instead of sourcemapRoot. This matches the name of the property in the source map, and esbuild's sourcesContent setting is an existing precedent for these settings matching the name of the corresponding source map property.

  • Right now the paths in the source map are relative to the absWorkingDir setting. Another option could be to change this to be relative to the outbase setting instead. I'm wondering which one is more appropriate.

@jridgewell
Copy link
Contributor Author

I think this should be sourceRoot instead of sourcemapRoot.

Sure, I can make that change tonight.

Right now the paths in the source map are relative to the absWorkingDir setting.

I actually like that it's relative to absWorkingDir, although setting it relative to could work. My experience is with Closure compiler, which uses the working directory. Rollup seems to make everything relative to the directory of the output sourcemap (thought they provide a function option to transform it). Webpack seems to use working directory, though they use an absolute webpack://package/PATH URL.

When making npm packages, I generally don't include the src directory in the package's published files. So making the sources relative to the build directory isn't correct, I use the sourceRoot to point to the git code at the specific version tag.

Perhaps we could just create an option for sourcemapOutbase, and have it default to whichever of absWorkingDir or outbase you prefer?

@jridgewell
Copy link
Contributor Author

This has been updated to --source-root, sourceRoot (JS), and SourceRoot (Go).

Copy link
Owner

@evanw evanw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable to me! Thanks for the PR.

@evanw evanw merged commit d57cb46 into evanw:master Mar 25, 2021
@jridgewell jridgewell deleted the sourceRoot branch March 25, 2021 06:51
evanw added a commit that referenced this pull request Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Relative source map file paths not found with vscode debugger
2 participants