mapped-yaml

A simple yaml parser providing source map as well.

1npm i mapped-yaml

Usage

1import { readFile } from 'fs/promises'
2import { parse } from 'mapped-yaml'
3
4
5async main() {
6  const content = await readFile('./stuff.yml', 'utf8')
7  const parsed = parse(content, './stuff.yml')
8
9  // 👉 access parsed contents of each node using `.object` property
10  assert(parsed.object['hellow'].object === 'world')
11  assert(parsed.object['stuff'].object[0].object === 42)
12  assert(parsed.object['stuff'].object[1].object['foo'].object === 'bar')
13  
14  // 👉 access location of each node using `.location` property
15  console.log(parsed.object['stuff'].object[1].location)
16
17  // {
18  //   file: File { ... },
19  //   range: {
20  //     start: { line: 4, character: 4 },
21  //     end: { line: 4, character: 11 }
22  //   }
23  // }
24  
25  // 👉 get the contents of the file maybe with some surrounding lines even
26  console.log(
27    parsed.location.file.range(                          // --> returns the contents of the file for given range
28      parsed.object['stuff'].object[0].location.range,   // --> the range of '- 42'
29      { surrounding: 1 }                                 // --> also return 1 surrounding line.
30    )
31  )
32  
33  // {
34  //   2: { content: 'stuff:', surround: true },
35  //   3: { content: '  - 42', surround: false },
36  //   4: { content: '  - foo: bar', surround: true }
37  // }
38}

1# stuff.yml
2hellow: world
3stuff:
4  - 42
5  - foo: bar

⚠️ Line and character indexes are ZERO-BASED. ⚠️

Acknowledgement

This is a simple wrapper over yaml. If you don't need source mapping, most probably you should just use that package.