Repository files navigation

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 aGulp/Grunt/Broccoli plugin.

npm install strip-json-comments

importstripJsonCommentsfrom'strip-json-comments';constjson=`{// 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-json-comments-cli - CLI for this module
• strip-css-comments - Strip comments from CSS