json-file-plus

Read from and write to a JSON file, minimizing diffs and preserving formatting.

npm install json-file-plus
22 downloads in the last day
306 downloads in the last week
1 314 downloads in the last month

json-file-plus Version Badge

Build Status dependency status dev dependency status

npm badge

A module to read from and write to JSON files, without losing formatting, to minimize diffs.

Example

var jsonFile = require('json-file-plus');
var path = require('path'); // in node-core
var filename = path.join(process.cwd(), 'package.json');
jsonFile(filename, function (err, file) {
    if (err) { return doSomethingWithError(err); }

    file.data; // Direct access to the data from the file
    file.format; // extracted formatting data. change at will.

    file.get('version'); // get top-level keys, synchronously
    file.get('version', callback); // get top-level keys, asynchronously
    file.get(); // get entire data, synchronously
    file.get(callback); // get entire data, asynchronously

    /* pass any plain object into "set" to merge in a deep copy */
    /* please note: references will be broken. */
    /* if a non-plain object is passed, will throw a TypeError. */
    file.set({
        foo: 'bar',
        bar: {
            baz: true
        }
    });

    /* change the filename if desired */
    file.filename = path.join(process.cwd(), 'new-package.json');

    /* Save the file, preserving formatting. */
    /* Callback will be passed to fs.writeFile */
    file.save(fsWriteFileCallback);
});

Tests

Simply run npm test in the repo

npm loves you