Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinnn/inline-source-map-comment
Create an inline source map comment from a source map object or string
https://github.com/shinnn/inline-source-map-comment
Last synced: 26 days ago
JSON representation
Create an inline source map comment from a source map object or string
- Host: GitHub
- URL: https://github.com/shinnn/inline-source-map-comment
- Owner: shinnn
- License: mit
- Created: 2014-10-06T07:34:39.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-16T12:19:43.000Z (over 8 years ago)
- Last Synced: 2024-09-24T08:06:59.882Z (about 2 months ago)
- Language: JavaScript
- Size: 34.2 KB
- Stars: 9
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# inline-source-map-comment
[![NPM version](https://img.shields.io/npm/v/inline-source-map-comment.svg)](https://www.npmjs.com/package/inline-source-map-comment)
[![Bower version](https://img.shields.io/bower/v/inline-source-map-comment.svg)](https://github.com/shinnn/inline-source-map-comment/releases)
[![Build Status](https://travis-ci.org/shinnn/inline-source-map-comment.svg?branch=master)](https://travis-ci.org/shinnn/inline-source-map-comment)
[![Build status](https://ci.appveyor.com/api/projects/status/57fmdhy41qainu8g?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/inline-source-map-comment)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/inline-source-map-comment.svg?label=cov)](https://coveralls.io/r/shinnn/inline-source-map-comment)
[![Dependency Status](https://img.shields.io/david/shinnn/inline-source-map-comment.svg?label=deps)](https://david-dm.org/shinnn/inline-source-map-comment)
[![devDependency Status](https://img.shields.io/david/shinnn/inline-source-map-comment.svg?label=devDeps)](https://david-dm.org/shinnn/inline-source-map-comment#info=devDependencies)Create an inline source map comment from a source map object or string
```javascript
var inlineSourceMapComment = require('inline-source-map-comment');var fixture = {
version:3,
file: 'output.js.map',
sources: ['input.js'],
names: [],
mappings: 'AAAA'
};inlineSourceMapComment(fixture);
//=> "//# sourceMappingURL=data:application/json;base64,eyJ2ZXJza ..."
```## Installation
### Package managers
#### [npm](https://www.npmjs.com/)
```sh
npm install inline-source-map-comment
```#### [bower](http://bower.io/)
```sh
bower install inline-source-map-comment
```#### [Duo](http://duojs.org/)
```javascript
var inlineSourceMapComment = require('shinnn/inline-source-map-comment');
```### Standalone
[Download the script file directly.](https://raw.githubusercontent.com/shinnn/inline-source-map-comment/master/inline-source-map-comment.js)
## API
### inlineSourceMapComment(*sourceMap* [, *options*])
*sourceMap*: `String` or `Object`
*options*: `Object`
Return: `String`It returns a line comment of [base64](https://wikipedia.org/wiki/Base64)-encoded [source map](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k).
Argument can be an object of source map or a JSON string.
```javascript
var map = '{"version":3,"file":"a.js.map","sources":["b.js"],"names":[],"mappings":"AAAA"}';inlineSourceMapComment(map);
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uI ... "inlineSourceMapComment(JSON.parse(map));
//=> (Same as `inlineSourceMapComment.js(map)`)
```It automatically removes `sourcesContent` property from result. Use [`sourcesContent` option](#optionssourcescontent) if you want to preserve `sourcesContent` property.
```javascript
var map = '{"version":3,"file":"foo.js.map","sources":["bar.js"], ...';
var one = inlineSourceMapComment(map);map.sourcesContent = 'foo';
var another inlineSourceMapComment(map);one === another; //=> true
```#### options.block
Type: `Boolean`
Default: `false`Returns a block comment instead of a line comment. It can be used for creating CSS source maps.
```javascript
var map = '{"version":3,"file":"foo.css.map","sources":["bar.js"], ...';inlineSourceMapComment(map, {block: true});
//=> "/* sourceMappingURL=data:application/json;base64,eyJ2ZXJ ... */"
```#### options.sourcesContent
Type: `Boolean`
Default: `false`Preserves the `sourcesContent` property.
### inlineSourceMapComment.prefix
Type: `String`
A common part of a Base64-encoded source map comment.
```javascript
inlineSourceMapComment.prefix;
//=> "# sourceMappingURL=data:application/json;base64,"
```## CLI
You can use this module as a CLI tool by installing it [globally](https://docs.npmjs.com/files/folders#global-installation).
```sh
npm install -g inline-source-map-comment
```### Usage
```sh
Usage1: inline-source-map-comment
Usage2: inline-source-map-comment --in
Usage3: cat | inline-source-map-commentOptions:
--block, --css, -b, -c Print a block comment instead of line comment
--sources-content, -s Preserve sourcesContent property
--in, --input, -i Use a JSON file as a source
--help, -h Print usage information
--version, -v Print version
```## License
Copyright (c) 2014 - 2015 [Shinnosuke Watanabe](https://github.com/shinnn)
Licensed under [the MIT License](./LICENSE).