remove-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 remove-json-comments

Usage

const json = '{/*rainbows*/"unicorn":"cake"}';

JSON.parse(stripJsonComments(json));
//=> {unicorn: 'cake'}

JSON Remove trailiing comma from last object

var json = `
{
    [{
        "ITEM2": {
            "names": ["nameB", "nameC"]
        }
    }, // need to remove this comma!
    ]
}

`
JSON.parse(stripJsonComments(json));

API

stripJsonComments(input, [options])

input

Type: string

Accepts a string with JSON and returns a string without comments.

options

whitespace

Type: boolean Default: true

Replace comments with whitespace instead of stripping them entirely.

Benchmark

$ npm run bench

Related

• strip-json-comments - Strip comments from JSON
• strip-json-comments-cli - CLI for this module
• strip-css-comments - Strip comments from CSS

License

MIT © Sindre Sorhus