@speclynx/apidom-parser-adapter-yaml-1-2

@speclynx/apidom-parser-adapter-yaml-1-2 is a parser adapter for the YAML 1.2 format.

CST produced by lexical analysis is syntactically analyzed and ApiDOM structure using base ApiDOM namespace is produced.

Installation

You can install @speclynx/apidom-parser-adapter-yaml-1-2 via npm CLI by running the following command:

 $ npm install @speclynx/apidom-parser-adapter-yaml-1-2

Parse phases

The parse stage takes YAML string and produces ApiDOM structure using base ApiDOM namespace. There are two phases of parsing: Lexical Analysis and Syntactic Analysis.

Lexical Analysis

Lexical Analysis will take a YAML string and turn it into a stream of tokens. tree-sitter / web-tree-sitter is used as an underlying lexical analyzer.

Syntactic Analysis

Syntactic Analysis will take a stream of tokens and turn it into an ApiDOM representation. CST produced by lexical analysis is syntactically analyzed and ApiDOM structure using base ApiDOM namespace is produced.

Parser adapter API

This parser adapter is fully compatible with parser adapter interface required by @speclynx/apidom-parser and implements all required properties.

mediaTypes

Defines list of media types that this parser adapter recognizes.

['text/yaml', 'application/yaml']

detect

Detection indicates whether the provided source string is valid YAML.

Option	Type	Default	Description
`strict`	`Boolean`	`false`	Use strict detection mode (yaml library).

In default mode, detection uses tree-sitter for parsing with error recovery. In strict mode, detection uses the yaml library which is faster.

namespace

This adapter exposes an instance of base ApiDOM namespace.

parse

parse function consumes various options as a second argument. Here is a list of these options:

Option	Type	Default	Description
`sourceMap`	`Boolean`	`false`	Indicate whether to generate source maps.
`style`	`Boolean`	`false`	Indicate whether to capture format-specific style information for round-trip preservation.
`strict`	`Boolean`	`false`	Use strict parsing mode (yaml library). When `true`, parsing is faster but doesn't support source maps or style preservation.

All unrecognized arbitrary options will be ignored.

Parsing modes

This adapter supports two parsing modes:

Tree-sitter mode (default, strict: false):

Uses web-tree-sitter for parsing
Provides error recovery for malformed YAML
Supports source map generation
Supports style preservation (quoting styles, flow/block, comments, indentation)
Full YAML 1.2 spec compliance with custom AST

Strict mode (strict: true):

Uses yaml library for parsing
Faster performance
Does not support source maps (throws error if both strict and sourceMap are true)
Does not support style preservation (throws error if both strict and style are true)

Usage

This parser adapter can be used directly or indirectly via @speclynx/apidom-parser.

Direct usage

During direct usage you don't need to provide mediaType as the parse function is already pre-bound with supported media types.

import { parse, detect } from '@speclynx/apidom-parser-adapter-yaml-1-2';

// detecting (tree-sitter mode - default)
await detect('prop: value'); // => true
await detect('{invalid:'); // => false

// detecting (strict mode)
await detect('prop: value', { strict: true }); // => true

// parsing (tree-sitter mode - default, with source maps)
const parseResult = await parse('prop: value', { sourceMap: true });

// parsing (tree-sitter mode, with style preservation)
const parseResultStyled = await parse('prop: value', { style: true });

// parsing (strict mode - faster, no source maps or style)
const parseResultStrict = await parse('prop: value', { strict: true });

Indirect usage

import ApiDOMParser from '@speclynx/apidom-parser';
import * as yamlParserAdapter from '@speclynx/apidom-parser-adapter-yaml-1-2';

const parser = new ApiDOMParser();

parser.use(yamlParserAdapter);

const parseResult = await parser.parse('prop: value', { mediaType: yamlParserAdapter.mediaTypes.latest('yaml') });