feat: using source maps for better stack traces #2975
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jakebailey
requested changes
Sep 27, 2024
pkerschbaum
force-pushed
the
feat/add-source-maps-hint-regarding-stack-traces
branch
from
de7dcc8 to
3f8aa58
Compare
pkerschbaum
force-pushed
the
feat/add-source-maps-hint-regarding-stack-traces
branch
from
3f8aa58 to
3915aeb
Compare
|
@jakebailey I improved the text a little bit! |
jakebailey
reviewed
Oct 8, 2024
| - **`sourceMap: true`** and **`declarationMap: true`** emit source maps for the output JavaScript and type declaration files, respectively. These are only useful if the library also ships its source (`.ts`) files. By shipping source maps and source files, consumers of the library will be able to debug the library code somewhat more easily. By shipping declaration maps and source files, consumers will be able to see the original TypeScript sources when they run Go To Definition on imports from the libraries. Both of these represent a tradeoff between developer experience and library size, so it’s up to you whether to include them. | ||
| - **`sourceMap: true`** emits source maps for the output JavaScript files. By shipping source maps, when consumers of the library execute the code with source maps enabled (e.g. via [`node --enable-source-maps`](https://nodejs.org/docs/latest-v18.x/api/cli.html#--enable-source-maps)), stack traces of errors will point to the original source TypeScript files (instead of the emitted output JavaScript files). When the source files are also shipped with the library, source maps allow consumers of the library to debug the library code somewhat more easily. | ||
| - **`declarationMap: true`** emits source maps for the output type declaration files. By shipping declaration maps and source files, consumers will be able to see the original TypeScript sources when they run Go To Definition on imports from the libraries. | ||
| - Note that **`sourceMap: true`** and **`declarationMap: true`** represent a tradeoff between developer experience and library size, so it’s up to you whether to include them. |
There was a problem hiding this comment.
The pattern here has been for each bullet to be about a specific compiler option, but this one is clarifying the previous lines. I'm not sure how to do better, though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the section about
I’m writing a library, regardingsourceMap: trueanddeclarationMap: true, the docs currently state:IMO source maps for the output JavaScript files can also be useful for better stack traces.
I added a sentence for that and removed the hint quoted above (because for better stack traces the source maps alone are sufficient; the source files don't need to be distributed also).