Package Exports

utils-fs-read-json5

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (utils-fs-read-json5) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Read JSON5

Reads the entire contents of a JSON5 file.

Installation

$ npm install utils-fs-read-json5

Usage

var read = require( 'utils-fs-read-json5' );

read( path, [ options,] clbk )

Reads the entire contents of a JSON5 file.

read( '/path/to/data.json5', onData );

function onData( error, data ) {
    if ( error ) {
        console.error( error );
    } else {
        console.log( data );
    }
}

The function accepts the same options as fs.readFile(), but encoding is always set to utf8. In addition, a JSON reviver may be provided.

var opts = {
    'reviver': reviver
};

read( '/path/to/data.json5', opts, onData );

function onData( error, data ) {
    if ( error ) {
        console.error( error );
    } else {
        console.log( data );
    }
}

function reviver( key, value ) {
    if ( key === 'beep' ) {
        return 'boop';
    }
    return value;
}

read.sync( path[, options] )

Synchronously reads the contents of an entire JSON5 file.

var out = read.sync( '/path/to/data.json5' );
if ( out instanceof Error ) {
    throw out;
}
console.log( out );

The function accepts the same options as fs.readFileSync() and supports JSON5#parse options.

Examples

var path = require( 'path' ),
    read = require( 'utils-fs-read-json5' );

var file = path.join( __dirname, 'config.json5' );

// Sync:
var data = read.sync( file, 'utf8' );
// returns <object>

console.log( data instanceof Error );
// returns false

data = read.sync( 'beepboop', {
    'encoding': 'utf8'
});
// returns <error>

console.log( data instanceof Error );
// returns true


// Async:
read( file, onRead );
read( 'beepboop', onRead );

function onRead( error, config ) {
    if ( error ) {
        if ( error.code === 'ENOENT' ) {
            console.error( 'JSON5 file does not exist.' );
        } else {
            throw error;
        }
    } else {
        console.log( 'Port: %s.', config.server.port );
    }
}

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

utils-fs-read-json5