Package Exports

@stoplight/yaml

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stoplight/yaml) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@stoplight/yaml

Useful functions when working with YAML.

Explore the interfaces: TSDoc
View the changelog: Releases

Installation

Supported in modern browsers and node.

# latest stable
yarn add @stoplight/yaml

Usage

parseWithPointers: Parses YAML into JSON and also returns a source map that includes a JSON path pointer for every property in the result (with line information).

// basic example of parseWithPointers
import { parseWithPointers } from "@stoplight/yaml";

const result = parseWithPointers("foo: bar");

console.log(result.data); // => the {foo: "bar"} JS object
console.log(result.pointers); // => the source map with a single "#/foo" pointer that has position info for the foo property

Contributing

Clone repo.
Create / checkout feature/{name}, chore/{name}, or fix/{name} branch.
Install deps: yarn.
Make your changes.
Run tests: yarn test.prod.
Stage relevant files to git.
Commit: yarn commit. NOTE: Commits that don't follow the conventional format will be rejected. yarn commit creates this format for you, or you can put it together manually and then do a regular git commit.
Push: git push.
Open PR targeting the next branch.