History

Mylloon 55fa0532a2 Add ESLint		2022-06-23 02:27:43 +02:00
..
index.d.ts	Add ESLint	2022-06-23 02:27:43 +02:00
index.js	Add ESLint	2022-06-23 02:27:43 +02:00
license	Add ESLint	2022-06-23 02:27:43 +02:00
package.json	Add ESLint	2022-06-23 02:27:43 +02:00
readme.md	Add ESLint	2022-06-23 02:27:43 +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 strip-json-comments

Usage

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

whitespace

Type: boolean
Default: true

Replace comments with whitespace instead of stripping them entirely.

Benchmark

$ npm run bench

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

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}