Package Exports

utils-json5-parse

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-json5-parse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Parse

Attempts to parse an input string as JSON5.

Installation

$ npm install utils-json5-parse

Usage

var parse = require( 'utils-json5-parse' );

parse( value[, reviver] )

Attempts to parse an input string as JSON5.

var out = parse( '{"beep":"boop"}' );
// returns {'beep':'boop'}

out = parse( '{beep:boop"}' );
// returns <SyntaxError>

The API is the same as JSON5#parse. Hence, to use a custom reviver function

var out;

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

out = parse( '{"beep":"boop","a":"b"}', reviver );
// returns {'beep':'boop'}

Notes

This function wraps JSON5#parse in a try/catch block.
The presence of try/catch within any function prevents JavaScript compiler optimization. By isolating the try/catch block, we minimize the extent of optimization hell.

Examples

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

// Load a JSON5 file...
var file = path.resolve( '/path/to/file.json5' );
file = fs.readFileSync( file, {
    'encoding': 'utf8'
});

// Attempt to parse the file...
file = parse( file );
console.dir( file );

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-json5-parse