node-sonparser

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

For more information, view the documentation.

Installation

npm install sonparser --save

Quick Example

Javascript

1var sonparser = require("sonparser");
2
3var result;
4
5var ExampleTsConfParser = sonparser.hasProperties([
6  ["compilerOptions", sonparser.hasProperties([
7    ["target", sonparser.string],
8    ["module", sonparser.string],
9    ["noImplicitAny", sonparser.boolean.option(false)],
10    ["preserveConstEnums", sonparser.boolean.option(false)],
11  ])],
12  ["exclude", sonparser.array(sonparser.string).option([])],
13]);
14
15result = ExampleTsConfParser.parse({
16  "compilerOptions": {
17    "target": "es5",
18    "module": "commonjs"
19  },
20  "exclude": [
21    "node_modules",
22    "build"
23  ]
24});
25
26result = ExampleTsConfParser.parse({
27  "compilerOptions": {
28    "target": 5,
29    "module": "commonjs"
30  }
31}); // throw Error!

Typescript

1/// <reference path="node_modules/sonparser/lib-typings/sonparser.d.ts" />
2
3import * as sonparser from "sonparser";
4
5let result: TsConfig;
6
7interface CompilerOptions {
8  target: string;
9  module: string;
10  noImplicitAny: boolean;
11  preserveConstEnums: boolean;
12}
13
14interface TsConfig {
15  compilerOptions: CompilerOptions;
16  exclude: string[];
17}
18
19const ExampleTsConfParser = sonparser.hasProperties<TsConfig>([
20  ["compilerOptions", sonparser.hasProperties<CompilerOptions>([
21    ["target", sonparser.string],
22    ["module", sonparser.string],
23    ["noImplicitAny", sonparser.boolean.option(false)],
24    ["preserveConstEnums", sonparser.boolean.option(false)],
25  ])],
26  ["exclude", sonparser.array(sonparser.string).option([])],
27]);
28
29result = ExampleTsConfParser.parse({
30  compilerOptions: {
31    target: "es5",
32    module: "commonjs"
33  },
34  exclude: [
35    "node_modules",
36    "build"
37  ]
38});
39
40result = ExampleTsConfParser.parse({
41  compilerOptions: {
42    target: 5,
43    module: "commonjs"
44  }
45}); // throw Error!

License

MIT