node-sonparser

Safe parser of JSON and CSON for config parsing like ConfigParser of python.

[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![Dependency status][gemnasium-image]][gemnasium-url]

For more information, view the [documentation][main-document].

Installation

``
npm install sonparser --save
`

Quick Example

$3

`javascript
var sonparser = require("sonparser");

var result;

var ExampleTsConfParser = sonparser.hasProperties([
["compilerOptions", sonparser.hasProperties([
["target", sonparser.string],
["module", sonparser.string],
["noImplicitAny", sonparser.boolean.option(false)],
["preserveConstEnums", sonparser.boolean.option(false)],
])],
["exclude", sonparser.array(sonparser.string).option([])],
]);

result = ExampleTsConfParser.parse({
"compilerOptions": {
"target": "es5",
"module": "commonjs"
},
"exclude": [
"node_modules",
"build"
]
});

result = ExampleTsConfParser.parse({
"compilerOptions": {
"target": 5,
"module": "commonjs"
}
}); // throw Error!
`

$3

`typescript
///

import * as sonparser from "sonparser";

let result: TsConfig;

interface CompilerOptions {
target: string;
module: string;
noImplicitAny: boolean;
preserveConstEnums: boolean;
}

interface TsConfig {
compilerOptions: CompilerOptions;
exclude: string[];
}

const ExampleTsConfParser = sonparser.hasProperties([
["compilerOptions", sonparser.hasProperties([
["target", sonparser.string],
["module", sonparser.string],
["noImplicitAny", sonparser.boolean.option(false)],
["preserveConstEnums", sonparser.boolean.option(false)],
])],
["exclude", sonparser.array(sonparser.string).option([])],
]);

result = ExampleTsConfParser.parse({
compilerOptions: {
target: "es5",
module: "commonjs"
},
exclude: [
"node_modules",
"build"
]
});

result = ExampleTsConfParser.parse({
compilerOptions: {
target: 5,
module: "commonjs"
}
}); // throw Error!
``

License

MIT

[npm-image]: https://img.shields.io/npm/v/sonparser.svg?style=flat-square
[npm-url]: https://npmjs.org/package/sonparser
[travis-image]: https://travis-ci.org/mizunashi-mana/node-sonparser.svg?branch=master
[travis-url]: https://travis-ci.org/mizunashi-mana/node-sonparser
[license-image]: http://img.shields.io/npm/l/sonparser.svg?style=flat-square
[license-url]: LICENSE
[downloads-image]: http://img.shields.io/npm/dm/sonparser.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/sonparser
[main-document]: docs/man/README.md
[fantasy-land-logo]: https://github.com/fantasyland/fantasy-land/raw/master/logo.png
[fantasy-land-url]: https://github.com/fantasyland/fantasy-land
[gemnasium-image]: https://gemnasium.com/badges/github.com/mizunashi-mana/node-sonparser.svg
[gemnasium-url]: https://gemnasium.com/github.com/mizunashi-mana/node-sonparser