Skip to content
/ shush Public

A simple module for reading JSON files that may have comments.

License

Notifications You must be signed in to change notification settings

krakenjs/shush

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

shush

Hush up those JSON comments.

shush is a simple node module that allows JSON files containing comments to be read into a module using a require-like syntax.

/* jsonWithComments.js */
{
    // a property
    "myProp": "isCool"
}
// foo.js
var shush = require('shush'),
    config = shush('./jsonWithComments');

console.log(config); // {"myProp": "isCool"}
// foo.js es6 modules
import shush from 'shush';
const config = shush('./jsonWithComments.json');

console.log(config); // {"myProp": "isCool"}

Forthcoming feature: streaming.

About

A simple module for reading JSON files that may have comments.

Resources

License

Stars

Watchers

Forks

Packages

No packages published