No Password Management

    strip-json-comments
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    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 --save strip-json-comments
    

    Usage

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

    API

    stripJsonComments(input, [options])

    input

    Type: string

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

    options

    whitespace

    Type: boolean
    Default: true

    Replace comments with whitespace instead of stripping them entirely.

    Related

    License

    MIT © Sindre Sorhus

    Install

    npm i strip-json-comments@2.0.1

    Version

    2.0.1

    License

    MIT

    Last publish

    Collaborators

    • sindresorhus