strip-json-comments

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

Code Quality Rank: L3

Monthly Downloads: 0

Programming language: JavaScript

License: MIT License

Tags: JSON     Parsing     Multiline     Config     Parse     Util     Configuration     Env     Comments     Trim     Delete     Remove     Strip     Environment     Settings     Conf    

Latest version: v3.1.1

README

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 stripJsonComments = require('strip-json-comments');

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

• 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 companiesassurances about security, maintenance, and licensing for their dependencies.