update after landing #1028

evanw · Mar 25, 2021 · 9d20802 · 9d20802
1 parent d57cb46
commit 9d20802
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## Unreleased
+
+* Add the ability to set `sourceRoot` in source maps ([#1028](https://github.com/evanw/esbuild/pull/1028))
+
+    You can now use the `--source-root=` flag to set the `sourceRoot` field in source maps generated by esbuild. When a `sourceRoot` is present in a source map, all source paths are resolved relative to it. This is particularly useful when you are hosting compiled code on a server and you want to point the source files to a GitHub repo, such as [what AMP does](https://cdn.ampproject.org/v0.mjs.map).
+
+    Here is the description of `sourceRoot` from [the source map specification](https://sourcemaps.info/spec.html):
+
+    > An optional source root, useful for relocating source files on a server or removing repeated values in the "sources" entry. This value is prepended to the individual entries in the "source" field. If the sources are not absolute URLs after prepending of the "sourceRoot", the sources are resolved relative to the SourceMap (like resolving script src in a html document).
+
+    This feature was contributed by [@jridgewell](https://github.com/jridgewell).
+
 ## 0.9.7
 
 * Add support for Android on ARM 64-bit ([#803](https://github.com/evanw/esbuild/issues/803))

diff --git a/cmd/esbuild/main.go b/cmd/esbuild/main.go
@@ -82,11 +82,10 @@ var helpText = func(colors logger.Colors) string {
   --resolve-extensions=...  A comma-separated list of implicit extensions
                             (default ".tsx,.ts,.jsx,.js,.css,.json")
   --servedir=...            What to serve in addition to generated output files
+  --source-root=...         Sets the "sourceRoot" field in generated source maps
   --sourcefile=...          Set the source file for the source map (for stdin)
   --sourcemap=external      Do not link to the source map with a comment
   --sourcemap=inline        Emit the source map with an inline data URL
-  --source-root=...         The root path from which source files are looked up
-	                          in a source map.
   --sources-content=false   Omit "sourcesContent" in generated source maps
   --tree-shaking=...        Set to "ignore-annotations" to work with packages
                             that have incorrect tree-shaking annotations