require-json5

Require JSON5 files in node - a better JSON for the JSNext era

JSON5 is more human friendly, can contain comments, trailing commas, unquoted keys and more!

Install

1npm i -S require-json5

Usage

Include the lib:

1const requireJSON5 = require('require-json5');

1. Require a JSON5 file

1let config = require("./config.json5");
2 // or w/o the extension, when "./config.json5" exists and there is no "./config.json", nor "./config.js"
3let config = require("./config");

2. Explicitly load a .json file in JSON5 format

1let config = requireJSON5("./config.json");

3. Load a .js file as JSON5 format. This is useful if you don't like the .json5 file extension and prefer to keep JSON5 in .js files.

1let config = requireJSON5("./config.js");

3. Parse a JSON5 string

1let config = requireJSON5.parse('{ name: /*a very important option*/ "value" }');

4. Use JSON5 for all require(.json) calls

1require('require-json5').replace();
2let config = require("./config"); // can be config.json, config.json5 or config.js

5. Restore the original require(.json)

1require('require-json5').restore();

Example of JSON5

The following is a contrived example, but it illustrates most of the features:

1{
2    foo: 'bar',
3    while: true,
4 
5    this: 'is a \
6multi-line string',
7 
8    // this is an inline comment 
9    here: 'is another', // inline comment 
10 
11    /* this is a block comment
12       that continues on another line */
13 
14    hex: 0xDEADbeef,
15    half: .5,
16    delta: +10,
17    to: Infinity,   // and beyond! 
18 
19    finally: 'a trailing comma',
20    oh: [
21        "we shouldn't forget",
22        'arrays can have',
23        'trailing commas too',
24    ],
25}

For more details on the JSON5 format see the json5 library.