Need help with strip-json-comments?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
sindresorhus

Description

Strip comments from JSON. Lets you use comments in your JSON files!

474 Stars 35 Forks MIT License 66 Commits 0 Opened issues

Services available

Need anything else?

strip-json-comments Build Status

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

Related


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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.