README

Parse

Attempts to parse an input string as YAML.

Installation

$ npm install utils-yaml-parse

Usage

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

parse( value[, options] )

Attempts to parse an input string as YAML.

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

out = parse( 'beep boop' );
// returns <Error>

The function signature is the same as yaml#safeLoad.

Notes

This function wraps yaml#safeLoad 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-yaml-parse' );

// Load a YAML file...
var file = '/path/to/file.yml';
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-yaml-parse

Usage no npm install needed!