Package Exports
- strip-json-comments
- strip-json-comments/strip-json-comments
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 (strip-json-comments) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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-commentsUsage
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 benchRelated
- strip-json-comments-cli - CLI for this module
- strip-css-comments - Strip comments from CSS