@jtwebb/strip-json-comments
v1.0.0
Published
Strip comments from JSON. Lets you use comments in your JSON files!
Downloads
2
Readme
strip-json-comments
Strip comments from JSON. Lets you use comments in your JSON files!
📘 Info
This package is a direct copy of https://github.com/sindresorhus/strip-json-comments. The only reason this package exists is because I needed it to support .cjs. If you don't need that support, please use the original package.
This is now possible:
{
// Rainbows
"unicorn": /* ❤ */ "cake"
}
It will replace single-line comments //
and multi-line comments /**/
with whitespace. This allows JSON error positions to remain as close as possible to the original source.
Also available as a Gulp/Grunt/Broccoli plugin.
Install
$ npm install strip-json-comments
Usage
import stripJsonComments from 'strip-json-comments';
const json = `{
// Rainbows
"unicorn": /* ❤ */ "cake"
}`;
JSON.parse(stripJsonComments(json));
//=> {unicorn: 'cake'}
API
stripJsonComments(jsonString, options?)
jsonString
Type: string
Accepts a string with JSON and returns a string without comments.
options
Type: object
whitespace
Type: boolean
Default: true
Replace comments with whitespace instead of stripping them entirely.
Benchmark
$ npm run bench
Related
- strip-json-comments-cli - CLI for this module
- strip-css-comments - Strip comments from CSS