https://github.com/valpackett/broccoli-source-map

A Broccoli plugin for inlining or extracting sourcemaps.
https://github.com/valpackett/broccoli-source-map

broccoli broccoli-plugin css javascript source-maps

Last synced: 10 months ago
JSON representation

A Broccoli plugin for inlining or extracting sourcemaps.

• Host: GitHub
• URL: https://github.com/valpackett/broccoli-source-map
• Owner: valpackett
• License: unlicense
• Created: 2014-07-04T22:24:06.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-04-04T14:03:51.000Z (almost 10 years ago)
• Last Synced: 2025-04-15T09:53:02.300Z (10 months ago)
• Topics: broccoli, broccoli-plugin, css, javascript, source-maps
• Language: JavaScript
• Size: 24.4 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# broccoli-source-map [![npm version](https://img.shields.io/npm/v/broccoli-source-map.svg?style=flat)](https://www.npmjs.org/package/broccoli-source-map) [![npm downloads](https://img.shields.io/npm/dm/broccoli-source-map.svg?style=flat)](https://www.npmjs.org/package/broccoli-source-map) [![Build Status](https://img.shields.io/travis/myfreeweb/broccoli-source-map.svg?style=flat)](https://travis-ci.org/myfreeweb/broccoli-source-map) [![Dependency Status](https://img.shields.io/gemnasium/myfreeweb/broccoli-source-map.svg?style=flat)](https://gemnasium.com/myfreeweb/broccoli-source-map) [![Unlicense](https://img.shields.io/badge/un-license-green.svg?style=flat)](http://unlicense.org)

A [Broccoli] plugin for inlining or extracting [JavaScript and CSS source maps] using [convert-source-map].

[Broccoli]: https://github.com/broccolijs/broccoli

[JavaScript and CSS source maps]: http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/

[convert-source-map]: https://www.npmjs.org/package/convert-source-map

## Installation

```bash

$ npm install --save-dev broccoli-source-map

```

## Usage

```js

var sourceMap = require('broccoli-source-map')

var src = 'js_and_maps' // probably something like: sweetjs('js', {sourceMap: true, readableNames: true});

var inlined = new sourceMap.SourceMapInliner([src])

var extracted = new sourceMap.SourceMapExtractor([inlined])

```

### inline

`require('broccoli-source-map').SourceMapInliner` combines pairs of `.js` and `.js.map` (`.css` and `.css.map`) files into one `.js` (`.css`) file that contains the source map as a base64 URL comment.

If the map contains file references in the `sources` field, but not the `sourcesContent` field, it will also inline the files into that field to make the compiled file independent of the source file.

This is very useful if you want to use [broccoli-browserify] because browserify reads inline source maps, but not external ones.

[broccoli-browserify]: https://github.com/gingerhendrix/broccoli-browserify

### extract

`require('broccoli-source-map').SourceMapExtractor` extracts source maps from base64 URL comments of `.js` (`.css`) files into separate `.js.map` (`.css.map`) files, just like [exorcist].

[exorcist]: https://github.com/thlorenz/exorcist

## Contributing

Please feel free to submit pull requests!

By participating in this project you agree to follow the [Contributor Code of Conduct](http://contributor-covenant.org/version/1/4/).

## License

This is free and unencumbered software released into the public domain.  

For more information, please refer to the `UNLICENSE` file or [unlicense.org](http://unlicense.org).