TripSit

Archived

This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.

History

cranberry ed23347e56 Initial comission of TheLounge base files		2020-11-01 22:46:04 +00:00
..
index.d.ts	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
index.js	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
license	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
package.json	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
readme.md	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00: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

<b>
    <a href="https://tidelift.com/subscription/pkg/npm-strip-json-comments?utm_source=npm-strip-json-comments&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
</b>
<br>
<sub>
    Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
</sub>