strip-json-comments
Advanced tools
Weekly downloads
Readme
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.
npm install strip-json-comments
import stripJsonComments from 'strip-json-comments';
const json = `{
// Rainbows
"unicorn": /* ❤ */ "cake"
}`;
JSON.parse(stripJsonComments(json));
//=> {unicorn: 'cake'}
Type: string
Accepts a string with JSON and returns a string without comments.
Type: object
Type: boolean
Default: false
Strip trailing commas in addition to comments.
Type: boolean
Default: true
Replace comments and trailing commas with whitespace instead of stripping them entirely.
npm run bench
Strip comments from JSON. Lets you use comments in your JSON files!
The npm package strip-json-comments receives a total of 45,488,608 weekly downloads. As such, strip-json-comments popularity was classified as popular.
We found that strip-json-comments demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.