utils-ini-parse v1.0.0

Parse

Attempts to parse an input string as INI.

Installation

$ npm install utils-ini-parse

Usage

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

parse( value, options )

Attempts to parse an input string as INI.

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

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

The function accepts the same options as utils-properties-parse, except

• sections is always true.
• separators is always '='.
• strict is always true.
• comments, by default, begin with ';'.

var out = parse( '# This is a comment.\nbeep=boop', {
	'comments': [ ';', '#' ]
});
// returns {'beep':'boop'}

Examples

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

// Load an INI file...
var file = '/path/to/file.ini';
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.