A highly forgiving and configurable INI parser for the informal INI file format.
The INI file format is informal. Different parsers behave differently, in that they support different features. This parser aims to be a bit more flexible and configurable to suite your needs, whatever they may be. Also, it assumes INI files out there in the wild could have some pretty crazy things in them. This parser does its best to understand whatever crazy you throw at it.
No dependencies on Node.js here, so you should be able to use it in the browser.
; example.ini
a=b
[c]
d:e
[c]
f=gimport { readFileSync } from "fs";
import Parser from "@jedmao/ini-parser";
const { configure, parse } = new Parser(/* config */);
parse(fs.readFileSync("./example.ini"));See Parser#parse API.
[
{
"a": "b"
},
[
[
"c",
{
"d": "e"
}
],
[
"c",
{
"f": "g"
}
]
]
]import Parser from "@jedmao/ini-parser";Class constructor. Accepts ParseOptions for initial configuration.
Sets configuration options, preserving existing configuration and overriding only the new keys you provide.
Resets configuration to default settings as if you created a new Parser().
Parses INI file contents as a string. The result will be an array:
- Index
0will have any/all root properties. - Index
1will have an array of any/all sections that follow.
Note: repeated sections will also be repeated in the array.
See Usage for an example.
interface ParseOptions {
/**
* Indicates accepted comment chars. Only works if you specify single-char
* comment values in RegExp form. A setting of `false` turns off comments
* completely, treating comment chars as normal string values.
* @default {RegExp} /[#;]/
*/
comment?: RegExp | false;
/**
* Accepts comment chars in a property key or value. If a space
* follows the comment char, it is considered an actual comment.
* Example: "#k;=#v; #z" -> { "#k;": "#v;" }
* @default {false} false
*/
isCommentCharInProp?: boolean;
/**
* Indicates accepted delimiter chars. Only works if you specify
* single-char delimiter values in RegExp form.
* @default {RegExp} /[=:]/
*/
delimiter?: RegExp;
/**
* Indicates accepted newline sequences in the form of a RegExp.
* @default {RegExp} /\r?\n/
*/
newline?: RegExp;
/**
* By default, attempts to parse property values with `JSON.parse`.
* If unsuccessful, returns property value as a string. You may also
* provide your own resolve function here for custom property value
* resolution.
* @default {true} true
*/
resolve?: boolean | ResolveCallback;
}interface ResolveCallback {
(value: string, key?: string, fallback?: typeof parseValue): any;
}Attempts to parse a string value with JSON.parse. If unsuccessful, returns input string untouched.
Run the following command:
$ npm test
This will build scripts, run tests and generate a code coverage report. Anything less than 100% coverage will throw an error.
For much faster development cycles, run the following commands in 2 separate processes:
npm run build:watch
Compiles TypeScript source into the ./dist folder and watches for changes.
$ npm run watch
Runs the tests in the ./dist folder and watches for changes.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent