Wondering what’s next for npm?Check out our public roadmap! »

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

    3.1.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 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.

    Install

    npm i strip-json-comments

    DownloadsWeekly Downloads

    23,339,493

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    6.96 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar