website/node_modules/strip-json-comments/readme.md

In JohnCoene/chirp: 'Twitter' Networks Analyser

strip-json-comments

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

This is now possible:

{
    // rainbows
    "unicorn": /* ❤ */ "cake"
}

It will remove single-line comments // and multi-line comments /**/.

Also available as a gulp/grunt/broccoli plugin.

-

There's also json-comments, but it's only for Node.js, inefficient, bloated as it also minifies, and comes with a require hook, which is :(

Install

$ npm install --save strip-json-comments

$ bower install --save strip-json-comments

$ component install sindresorhus/strip-json-comments

Usage

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

API

stripJsonComments(input)

input

Type: string

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

CLI

$ npm install --global strip-json-comments

$ strip-json-comments --help

strip-json-comments input-file > output-file
# or
strip-json-comments < input-file > output-file

Related

• strip-css-comments

License

MIT © Sindre Sorhus

JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.