yaml-unist-parser/readme.md

A YAML parser that produces output compatible with unist

# yaml-unist-parser

[![npm](https://img.shields.io/npm/v/yaml-unist-parser.svg?style=flat-square)](https://www.npmjs.com/package/yaml-unist-parser)
[![coverage](https://img.shields.io/codecov/c/github/prettier/yaml-unist-parser.svg?style=flat-square)](https://codecov.io/gh/prettier/yaml-unist-parser)

A YAML parser that produces output compatible with [unist](https://github.com/syntax-tree/unist)

## Features

- better node positioning
- better comment attaching
- [unist-compatible AST](https://github.com/prettier/yaml-unist-parser/blob/main/src/types.ts)

## Install

```sh
# using npm
npm install --save yaml-unist-parser

# using yarn
yarn add yaml-unist-parser
```

## Usage

```ts
import { parse } from "yaml-unist-parser";

const ast = parse(`
- hello
- world
`);
```

## Options

### `uniqueKeys`

type `boolean`\
default: `true`

Whether key uniqueness is checked.

```js
parse("a: 1\na: 2");
// Uncaught SyntaxError [YAMLSyntaxError]: Map keys must be unique

parse("a: 1\na: 2", { uniqueKeys: false });
// {type: 'root',...}
```

## Development

```sh
# lint
yarn run lint

# build
yarn run build

# test
yarn run test
```

## License

MIT © [Ika](https://github.com/ikatyang)