2.0.0 • Published 4 years ago

require-strip-json-comments v2.0.0

Weekly downloads
131
License
MIT
Repository
github
Last release
4 years ago

require-strip-json-comments Build Status

Require .json files with comments.

For advanced JSON syntax I recomend using require-json5, which can load JSON with trailing commas, unquoted keys, hex numbers, comments, and more.

Install

npm i require-strip-json-comments

Usage

1) Load a JSON file which contains comments

var requireJSON = require('require-strip-json-comments');
var config = requireJSON("./config.json");

2) Parse a JSON string which contains comments

var requireJSON = require('require-strip-json-comments');
var config = requireJSON.parse('{"name": /*a very important option*/ "value"}');

3) Replace require()

require('require-strip-json-comments').replace_require();
var config = require("./config");

4) Replace JSON.parse()

require('require-strip-json-comments').replace_JSON();
var config = JSON.parse('{"name": /*a very important option*/ "value"}');

5) Replace require() and JSON.parse()

require('require-strip-json-comments').replace();
// ...