History

Loïc Bersier b2a654d3db commando		2018-09-09 21:20:36 +02:00
..
index.js	commando	2018-09-09 21:20:36 +02:00
license	commando	2018-09-09 21:20:36 +02:00
readme.md	commando	2018-09-09 21:20:36 +02:00

readme.md

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 --save strip-json-comments

Usage

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

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

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.

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