strip-json-comments
Strip comments from JSON. Lets you use comments in your JSON files!
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
trailingCommas
Type: boolean
Default: false
Strip trailing commas in addition to comments.
whitespace
Type: boolean
Default: true
Replace comments and trailing commas 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
Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.