Package Exports

yaml-eslint-parser
yaml-eslint-parser/lib/index.js

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 (yaml-eslint-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

yaml-eslint-parser

A YAML parser that produces output compatible with ESLint.

This parser is backed by excellent yaml package and it is heavily inspired by yaml-unist-parser package.

Installation

npm install --save-dev yaml-eslint-parser

Usage

Configuration

Use .eslintrc.* file to configure parser. See also: https://eslint.org/docs/user-guide/configuring.

Example .eslintrc.js:

module.exports = {
    "overrides": [
        {
            "files": ["*.yaml", "*.yml"],
            "parser": "yaml-eslint-parser"
        }
    ]
}

Usage for Custom Rules / Plugins

AST.md is AST specification.
block-mapping.ts is an example.
You can see the AST on the Online DEMO.

Usage for Directly

Example:

import type { AST } from "yaml-eslint-parser"
import { parseYAML, getStaticYAMLValue } from "yaml-eslint-parser"

const code = `
american:
  - Boston Red Sox
  - Detroit Tigers
  - New York Yankees
national:
  - New York Mets
  - Chicago Cubs
  - Atlanta Braves
`

const ast: AST.YAMLProgram = parseYAML(code)
console.log(ast)

const value = getStaticYAMLValue(ast)
console.log(value)

eslint-plugin-jsonc ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5.
eslint-plugin-yml ... ESLint plugin for YAML.
eslint-plugin-toml ... ESLint plugin for TOML.
eslint-plugin-json-schema-validator ... ESLint plugin that validates data using JSON Schema Validator.
jsonc-eslint-parser ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
toml-eslint-parser ... TOML parser for use with ESLint plugins.