json-file-plus

json-file-plus

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

Example

const jsonFile = require('json-file-plus');
const path = require('path');
const fs = require('fs');
const assert = require('assert');

const filename = path.join(process.cwd(), 'package.json');

const originalContents = String(fs.readFileSync(filename));

jsonFile(filename).then((file) => {
	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. returns a Promise
	file.get(); // get entire data. returns a Promise

	/* 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,
		},
	});

	file.remove('description'); // remove a specific key-value pair. returns a Promise

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

	/* Save the file, preserving formatting. returns a Promise. */
	file.save().then(() => {
		console.log('success!');

		const finalContents = String(fs.readFileSync(filename));
		assert.equal(originalContents, finalContents);
	}).catch((err) => {
		console.log('error!', err);
		process.exitCode = 1;
	}).finally(() => {
		fs.writeFileSync(filename, originalContents, { encoding: 'utf8' });
	});
});

Tests

Simply run npm test in the repo