You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
31 lines
599 B
31 lines
599 B
7 months ago
|
##### 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.
|
||
|
|
|
||
|
|
```json
|
||
|
|
/* jsonWithComments.js */
|
||
|
|
{
|
||
|
|
// a property
|
||
|
|
"myProp": "isCool"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
```javascript
|
||
|
|
// foo.js
|
||
|
|
var shush = require('shush'),
|
||
|
|
config = shush('./jsonWithComments');
|
||
|
|
|
||
|
|
console.log(config); // {"myProp": "isCool"}
|
||
|
|
```
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
// foo.js es6 modules
|
||
|
|
import shush from 'shush';
|
||
|
|
const config = shush('./jsonWithComments.json');
|
||
|
|
|
||
|
|
console.log(config); // {"myProp": "isCool"}
|
||
|
|
```
|
||
|
|
|
||
|
|
Forthcoming feature: streaming.
|