node package manager
Orgs are free. Discover, share, and reuse code in your team. Create a free org »

json-comments

Json Comments NPM version

Make your json config support comments.

Installation

$ npm install json-comments

Syntax:

// require `json-comments` in your main module only once 
require('json-comments');

Examples:

config.json

{
  // this is host 
  "host" : "localhost",
 
  "port" : 3000, //port 
 
  "url" : "https://github.com/numbcoder", /* url */
 
  /*
  * comments support for json
  */
  "username": "abc"
}

app.js

require('json-comments');
var config = require('./config');
 
console.log(config);
// ... 

Parse JSON string

var JSONC = require('json-comments');
var fs = require('fs');
 
var content = fs.readFileSync('./config.json', 'utf8');
// parse JSON String 
var config = JSONC.parse(content);
 
console.log(config);

Minify the JSON string

var JSONC = require('json-comments');
var fs = require('fs');
 
var content = fs.readFileSync('./config.json', 'utf8');
 
// remove comments and spaces from JSON String 
var JsonStr = JSONC.minify(content);

License

MIT