cartodb/node-source-map-support
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update documentation to reflect using the *last* source map in file.

Browse Source
This commit is contained in:
Martin Probst 2015-05-18 15:55:58 +02:00
parent b3fd2b9353
commit e6e77abddd
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -8,11 +8,16 @@ This module provides source map support for stack traces in node via the [V8 sta
npm install source-map-support
Source maps can be generated using libraries such as [source-map-index-generator](https://github.com/twolfson/source-map-index-generator). Once you have a valid source map, insert the following two lines at the top of your compiled code:
Source maps can be generated using libraries such as [source-map-index-generator](https://github.com/twolfson/source-map-index-generator). Once you have a valid source map, insert the following line at the top of your compiled code:
//# sourceMappingURL=path/to/source.map
require('source-map-support').install();
And place a source mapping comment somewhere in the file (usually done automatically or with an option by your transpiler):
//# sourceMappingURL=path/to/source.map
If multiple sourceMappingURL comments exist in one file, the last sourceMappingURL comment will be
respected (e.g. if a file mentions the comment in code, or went through multiple transpilers).
The path should either be absolute or relative to the compiled file.
It is also possible to to install the source map support directly by
@ -81,10 +86,11 @@ original.js:
compiled.js:
//# sourceMappingURL=compiled.js.map
require('source-map-support').install();
throw new Error('test'); // This is the compiled code
// The next line defines the sourceMapping.
//# sourceMappingURL=compiled.js.map
compiled.js.map: