# inline-source-map-comment > Create an inline source map comment from a source map Latest version **1.0.5** (published 2015-04-01) · 0 weekly downloads ## Install ```sh npm install inline-source-map-comment pnpm add inline-source-map-comment yarn add inline-source-map-comment bun add inline-source-map-comment ``` Provides the command `inline-source-map-comment`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.5 | | Published | 2015-04-01 | | First published | 2014-10-06 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 5 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 9 | | Author | Shinnosuke Watanabe | | Maintainers | shinnn | | Keywords | inline, sourcemap, source, map, comment, js, css, cli, browser, client-side | ## Links - npm: https://www.npmjs.com/package/inline-source-map-comment - Repository: https://github.com/shinnn/inline-source-map-comment - Issues: https://github.com/shinnn/inline-source-map-comment/issues - npm.io page: https://npm.io/package/inline-source-map-comment ## Dependencies (5) - [chalk](https://npm.io/package/chalk.md) ^1.0.0 - [xtend](https://npm.io/package/xtend.md) ^4.0.0 - [sum-up](https://npm.io/package/sum-up.md) ^1.0.1 - [minimist](https://npm.io/package/minimist.md) ^1.1.1 - [get-stdin](https://npm.io/package/get-stdin.md) ^4.0.1 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 1.0.5 (latest) — 2015-04-01 - 1.0.4 — 2015-02-24 - 1.0.3 — 2015-01-22 - 1.0.2 — 2014-12-13 - 1.0.1 — 2014-12-05 - 1.0.0 — 2014-10-08 - 0.0.0 — 2014-10-06 ## 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 `sourcesConteThe prefix string of basent` 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-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](https://github.com/shinnn) Licensed under [the MIT License](./LICENSE). --- _Source: https://npm.io/package/inline-source-map-comment · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._