athea

Repositories Projects Packages

strip-json-comments (3.1.1)

Published 2026-02-24 14:05:47 +00:00 by atheaadmin

Installation

Setup this registry in your project .npmrc file:

registry=

To install the package using npm, run the following command:

npm install strip-json-comments@3.1.1

or add it to the package.json file:

"strip-json-comments": "3.1.1"

For more information on the npm registry, see the documentation.

About this package

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

Related

• strip-json-comments-cli - CLI for this module
• strip-css-comments - Strip comments from CSS

---

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

Dependencies

Development Dependencies

ID	Version
ava	^1.4.1
matcha	^0.7.0
tsd	^0.7.2
xo	^0.24.0

Keywords

json strip comments remove delete trim multiline parse config configuration settings util env environment jsonc

Details

npm

2026-02-24 14:05:47 +00:00

0

Sindre Sorhus

Project Site

MIT

latest

2.8 KiB

Assets (1)

strip-json-comments-3.1.1.tgz 2.8 KiB

Versions (1) View all

3.1.1 2026-02-24