README.md

json-parser

JSON parser to parse JSON object and MAINTAIN comments.

This is a very low level module. For most situations, recommend to use comment-json instead.

Install

$ npm install json-parser --save

Usage

parser(text, [reviver=null,] [remove_comments=false])

• text String The string to parse as JSON. See the JSON object for a description of JSON syntax.
• reviver function()|null Default to null. It acts the same as the second parameter of JSON.parse. If a function, prescribes how the value originally produced by parsing is transformed, before being returned.
• remove_comments Boolean If true, the parsed JSON Object won't contain comments

Returns the Object corresponding to the given JSON text.

content

/**
 blah
 */
// comment at top
{
  // comment for a
  /* block comment */
  "a": 1 // comment at right
}
// comment at bottom

var parser = require('json-parser');
var object = parser.parse(content);
console.log(object);

And the result will be:

{
  // Comments at the top of the file
  '//^': ['/**\n blah\n */', '// comment at top'],

  // Comments at the bottom of the file
  '//$': ['// comment at bottom'],

  // Comment for a property is the value of `'// <prop>'`
  '// a': [
    ['// comment for a', '/* block comment */'],
    ['// comment at right']
  ],

  // The real value
  a: 1
}

var object_no_comments = parser.parse(content, null, true);
console.log(object_no_comments)

And the result will be:

{
  a: 1
}

License

MIT