One INI

The core implementation of an AST based, idiomatic INI parser which aims to provide an easy to implement and consistent INI-standard.

This reference implementation is provided as Rust-library and WASM-package.

The work on this project started with the search for an universal parser for the EditorConfig INI file format specification.

WASM

To use from Web Assembly, compile with:

1wasm-pack build --release --target nodejs

and run the (limited) WASM tests with:

1wasm-pack test --node

You can call the generated JS wrapper with either:

1import { parse_to_json } from './pkg/one_ini.js'
2
3const results = parse_to_json(`
4root = true
5
6[*]
7# always use unix line endings
8end_of_line = lf
9`)
10
11// {
12//   "version": "0.1.0",
13//   "body": [
14//     { "type": "Pair", "key": "root", "value": "true" },
15//     {
16//       "type": "Section",
17//       "name": "*",
18//       "body": [
19//         { "type": "Comment", "indicator": "#", "value": "always use unix line endings" },
20//         { "type": "Pair", "key": "end_of_line", "value": "lf" }
21//       ]
22//     }
23//   ]
24// }

or:

1import { parse_to_uint32array, TokenTypes } from './pkg/editorconfig_ini.js'
2const buf = Buffer.from(`
3root = true
4
5[*]
6# always use unix line endings
7end_of_line = lf
8`, 'utf8')
9const ary = parse_to_uint32array(buf)
10
11// Array with token type, start byte offset, end byte offset for each token
12// Uint32Array(21) [
13//   TokenTypes.Key, 1, 5,
14//   TokenTypes.Value, 8, 12,
15//   TokenTypes.Section, 15, 16,
16//   TokenTypes.CommentIndicator, 18, 19,
17//   TokenTypes.CommentValue, 20, 48,
18//   TokenTypes.Key, 49, 60,
19//   TokenTypes.Value, 63, 65
20// ]