Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@luxass/strip-json-comments

luxass5.8kMIT1.4.0TypeScript support: included

strip comments from your json

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

readme

strip-json-comments

npm version npm downloads

A fork of sindresorhus/strip-json-comments but with support for CJS & ESM. And some small modifications.

📦 Installation

npm install @luxass/strip-json-comments

📚 Usage

There is a small difference to the original package. You can see it here.

import { strip } from "@luxass/strip-json-comments";

const json = `{
  // this is a comment
  "foo": /* this is also a comment */ "bar"
}`;

JSON.parse(strip(json)); // { foo: "bar" }

Differences to sindresorhus/strip-json-comments

The main differences are:

  • This package is published as ESM & CJS
  • And the default export is moved to a named export called strip
- import stripJsonComments from "strip-json-comments";
+ import { strip } from "@luxass/strip-json-comments";

📄 License

Published under MIT License.