strip-json-comments
Advanced tools
Strip comments from JSON. Lets you use comments in your JSON files!
Package description
The strip-json-comments package allows you to strip comments from JSON content, making it possible to use comments in JSON files or strings for development purposes without violating the JSON format specification. This can be particularly useful for configuration files or complex JSON data where comments can provide valuable context or instructions.
Strip comments from JSON string
This feature allows you to remove both line (//) and block (/* */) comments from a JSON string, making it a valid JSON format. The code sample demonstrates how to use the package to strip comments from a JSON string containing both types of comments.
"use strict";\nconst stripJsonComments = require('strip-json-comments');\n\nconst jsonWithComments = '{\n\t// This is a comment\n\t"foo": true\n}';\nconst cleanedJson = stripJsonComments(jsonWithComments);\n\nconsole.log(cleanedJson); // {\n\t\"foo\": true\n}"json5 is a package that extends the JSON format to include some ECMAScript 5.1 features, such as comments, trailing commas, and more. While it offers a broader scope of features beyond just stripping comments, it can be used for a similar purpose of handling JSON data with comments.
jsonc-parser is a parser that handles JSONC (JSON with Comments) format. It is designed to parse and manipulate JSONC data, offering functionality to strip comments as part of its parsing process. Compared to strip-json-comments, jsonc-parser provides a more comprehensive parsing and manipulation toolset for JSONC.
Readme
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.
npm install strip-json-comments
import stripJsonComments from 'strip-json-comments';
const json = `{
// Rainbows
"unicorn": /* ❤ */ "cake"
}`;
JSON.parse(stripJsonComments(json));
//=> {unicorn: 'cake'}
Type: string
Accepts a string with JSON and returns a string without comments.
Type: object
Type: boolean
Default: false
Strip trailing commas in addition to comments.
Type: boolean
Default: true
Replace comments and trailing commas with whitespace instead of stripping them entirely.
npm run bench
FAQs
Strip comments from JSON. Lets you use comments in your JSON files!
The npm package strip-json-comments receives a total of 35,058,035 weekly downloads. As such, strip-json-comments popularity was classified as popular.
We found that strip-json-comments demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.