https://github.com/jamesplease/sourcemap-options
The future source map options for the entire grunt-contrib suite
https://github.com/jamesplease/sourcemap-options
Last synced: 3 months ago
JSON representation
The future source map options for the entire grunt-contrib suite
- Host: GitHub
- URL: https://github.com/jamesplease/sourcemap-options
- Owner: jamesplease
- License: mit
- Created: 2014-02-10T05:22:57.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-03-04T14:25:40.000Z (over 11 years ago)
- Last Synced: 2025-02-07T09:41:59.586Z (5 months ago)
- Homepage:
- Size: 185 KB
- Stars: 1
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
sourcemap-options
=================
The future source map options for the `grunt-contrib` suite. Any plugin that can't support the source map options through its associated library will rely on an external helper library (in the works) to shim the functionality.
### Options
#### sourceMap
Type: `boolean`
Default: `false`
Set to true to create a source map. The source map will be created alongside the destination file, and share the same file name with the `.map` extension appended to it.
#### sourceMapName
Type: `string` `function`
Default: `undefined`
To customize the name or location of the generated source map, pass a string to indicate where to write the source map to. If a function is provided, the destination file path is passed as the argument and the return value will be used as the file name.
#### sourceMapStyle
Type: `string`
Default: `"embed"`
Determines the type of source map that is generated. The default value, `embed`, places the content of the sources directly into the map. `link` will reference the original sources in the map as links. `inline` will store the entire map as a data URI in the destination file.
### Supported use cases
* The most basic case is supported by simply setting `sourceMap: true`. No other config necessary.
* Moving/changing the name of the map: using sourceMapName
* Including an older source map: done automatically by parsing the sourceMappingURL of any source files.
* The directory structure of the project differing from the webserver (for instance, the webroot being at, say, `/build`)
### Unsupported use cases
* Storing the source map on another server
* Separating the source map from the source files. Use the embed or datauri option instead
* Combining datauri with the `link` style
### Resources
* [Source Map Revision 3 Proposal](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit)