Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

require-json6

1.1.0 • Public • Published

require-json6 Build Status

Require JSON6 files in node - a better JSON for ES6 era

JSON6 is more human friendly, can contain comments, trailing commas, unquoted keys amd more!

Install

npm i require-json6

Usage

Include the lib:

const requireJSON6 = require('require-json6');
  1. Require a JSON6 file
let config = require("./config.json6");
  1. Load a .json file in JSON6 format
let config = requireJSON6("./config.json");
  1. Load a .js file as JSON6 format. This is useful if you don't like the .json6 file extension and prefer to keep JSON6 in .js files.
let config = requireJSON6("./config.js");
  1. Parse a JSON6 string
let config = requireJSON6.parse('{ name: /*a very important option*/ "value" }');
  1. Use JSON6 for all require(.json) calls
require('require-json6').replace();
let config = require("./config"); // can be config.json, config.json6 or config.js

Example of JSON6

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

{
    foo: 'bar',
    while: true,
 
    this: 'is a \
multi-line string',
 
    // this is an inline comment 
    here: 'is another', // inline comment 
 
    /* this is a block comment
       that continues on another line */
 
    hex: 0xDEADbeef,
    half: .5,
    delta: +10,
    to: Infinity,   // and beyond! 
 
    finally: 'a trailing comma',
    oh: [
        "we shouldn't forget",
        'arrays can have',
        'trailing commas too',
    ],
}

Install

npm i require-json6

DownloadsWeekly Downloads

2

Version

1.1.0

License

MIT

Unpacked Size

9.69 kB

Total Files

10

Last publish

Collaborators

  • avatar