Coder Social home page Coder Social logo

dominikg / strip-json-comments Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sindresorhus/strip-json-comments

0.0 1.0 0.0 135 KB

Strip comments from JSON. Lets you use comments in your JSON files!

License: MIT License

JavaScript 95.44% TypeScript 4.56%

strip-json-comments's Introduction


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


const stripJsonComments = require('strip-json-comments');

const json = `{
	// Rainbows
	"unicorn": /* ❤ */ "cake"

//=> {unicorn: 'cake'}


stripJsonComments(jsonString, options?)


Type: string

Accepts a string with JSON and returns a string without comments.


Type: object


Type: boolean
Default: true

Replace comments with whitespace instead of stripping them entirely.


$ npm run bench


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.

strip-json-comments's People


bendingbender avatar blakeembrey avatar c0ldf0x avatar chrisregnier avatar dtinth avatar edwardbetts avatar kevva avatar lydell avatar novacrazy avatar papb avatar richienb avatar sebmck avatar sindresorhus avatar slauyama avatar whitneyit avatar



Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.