Popularity
4.8
Growing
Activity
3.8
Declining
437
12
31

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

strip-json-comments alternatives and similar modules

Based on the "Parsing" category

Do you think we are missing an alternative of strip-json-comments or a related project?

Add another 'Parsing' Module

README

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

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.