strip-json-comments

WebJar for strip-json-comments

License	MIT
Categories	JSON Data
GroupId	org.webjars.bowergithub.sindresorhus
ArtifactId	strip-json-comments
Last Version	3.1.1
Release Date	Mar 5, 2021
Type	jar
Description	strip-json-comments WebJar for strip-json-comments
Project URL	https://www.webjars.org
Source Code Management	https://github.com/sindresorhus/strip-json-comments

Download strip-json-comments

Filename	Size
strip-json-comments-3.1.1.pom
strip-json-comments-3.1.1.jar	92 KB
strip-json-comments-3.1.1-sources.jar	22 bytes
strip-json-comments-3.1.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.sindresorhus/strip-json-comments/ -->
<dependency>
    <groupId>org.webjars.bowergithub.sindresorhus</groupId>
    <artifactId>strip-json-comments</artifactId>
    <version>3.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.bowergithub.sindresorhus/strip-json-comments/
implementation 'org.webjars.bowergithub.sindresorhus:strip-json-comments:3.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.bowergithub.sindresorhus/strip-json-comments/
implementation ("org.webjars.bowergithub.sindresorhus:strip-json-comments:3.1.1")

Apache Buildr

'org.webjars.bowergithub.sindresorhus:strip-json-comments:jar:3.1.1'

Apache Ivy

<dependency org="org.webjars.bowergithub.sindresorhus" name="strip-json-comments" rev="3.1.1">
  <artifact name="strip-json-comments" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.bowergithub.sindresorhus', module='strip-json-comments', version='3.1.1')
)

Scala SBT

libraryDependencies += "org.webjars.bowergithub.sindresorhus" % "strip-json-comments" % "3.1.1"

Leiningen

[org.webjars.bowergithub.sindresorhus/strip-json-comments "3.1.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

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

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

Versions

Version
3.1.1 Mar 5, 2021
3.0.1 Aug 9, 2019
2.0.1 Feb 13, 2019