utils-properties-parse

Attempts to parse an input string according to the .properties specification.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
utils-properties-parse
101.0.07 years ago7 years agoMinified + gzip package size for utils-properties-parse in KB

Readme

Parse
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscodecov-imagecodecov-url !Dependenciesdependencies-imagedependencies-url
Attempts to parse an input string according to the .properties specification.

Installation

$ npm install utils-properties-parse

Usage

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

parse( value, options )

Attempts to parse an input string according to the .properties specification.
var out = parse( 'beep boop' );
// returns {'beep':'boop'}

out = parse( '[beep boop', {
	'sections': true
});
// returns <Error>

The function signature is the same as properties#parse, except the path and include options are not supported.

Notes

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

// Load a .properties file...
var file = '/path/to/file.properties';
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.

Copyright

Copyright © 2015. Athan Reines.