@featurevisor/parsers

YAML and JSON parsers for reading, writing and formatting Featurevisor definitions, with a TypeScript contract for custom parsers.

Installation

npm install @featurevisor/parsers

Usage

Custom parsers provide both parse and stringify. For featurevisor fmt, a parser can also give an optional format(source, layout), which lays out a file with the FormatLayout Featurevisor passes it, options for its format included, and an optional listComments(source), so fmt can check that formatting kept every comment. In a format with comments, format keeps a line that ends with IGNORE_LINE_COMMENT as written. Use a built in parser directly:

import { parsers } from "@featurevisor/parsers";

const definition = parsers.yml.parse<{ description: string }>(
  "description: Checkout configuration",
);
console.log(parsers.json.stringify(definition));

See the documentation.

License

MIT © Fahad Heylaal