JSPM

inline-source-map-comment

1.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 118979
  • Score
    100M100P100Q234995F

Create an inline source map comment from a source map

Package Exports

  • inline-source-map-comment

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (inline-source-map-comment) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

inline-source-map-comment

NPM version Bower version Build Status Build status Coverage Status Dependency Status devDependency Status

Create an inline source map comment from a source map object or string

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

npm install inline-source-map-comment

bower

bower install inline-source-map-comment

Duo

var inlineSourceMapComment = require('shinnn/inline-source-map-comment');

Standalone

Download the script file directly.

API

inlineSourceMapComment(sourceMap [, options])

sourceMap: String or Object
options: Object
Return: String

It returns a line comment of base64-encoded source map.

Argument can be an object of source map or a JSON string.

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 if you want to preserve sourcesContent property.

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.

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 sourcesConteThe prefix string of basent property.

inlineSourceMapComment.prefix

Type: String

A common part of a Base64-encoded source map comment.

inlineSourceMapComment.prefix;
//=> "# sourceMappingURL=data:application/json;base64,"

CLI

You can use this module as a CLI tool by installing it globally.

npm install -g inline-source-map-comment

Usage

Usage1: inline-source-map-comment <source map string>
Usage2: inline-source-map-comment --in <source map file>
Usage3: cat <source map file> | inline-source-map-comment

Options:
--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

Licensed under the MIT License.