Need help with strip-json-comments?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus
500 Stars 38 Forks MIT License 68 Commits 0 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

# 80
Shell
exec
test-fr...
nextjs
41 commits
# 3,128
ESLint
Markdow...
eslint-...
GraphQL
2 commits
# 101,592
travis-...
ESLint
ecmascr...
Angular
1 commit
# 577,991
JavaScr...
TypeScr...
npm-pac...
1 commit
# 276
JavaScr...
Babel
ast
TypeScr...
1 commit
# 242,513
Rust
interpo...
MATLAB
Shell
1 commit
# 5,416
imagemi...
Babel
minify
exec
1 commit
# 15,429
catalin...
exec
rhythm-...
html5
1 commit
# 131,686
CSS
Shell
C
npm-pac...
1 commit
# 5,774
TypeScr...
raml
express...
repl
1 commit
# 21,639
Gin
curl
simulat...
netflix
1 commit
# 576,367
JavaScr...
TypeScr...
npm-pac...
1 commit
# 7,406
TypeScr...
iterm2
Node.js
exec
1 commit
# 6,862
chalk
iterm2
exec
Electro...
1 commit
# 9,410
exec
React
SQLite
transac...
1 commit

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 stripJsonComments = require('strip-json-comments');

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.