@3rd/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.

Install

npm install @3rd/strip-json-comments

Usage

import stripJsonComments from '@3rd/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

trailingCommas

Type: boolean
Default: false

Strip trailing commas in addition to comments.

whitespace

Type: boolean
Default: true

Replace comments and trailing commas with whitespace instead of stripping them entirely.

Related

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