tiny
Esc

tinyaml

ESLint

View as Markdown

Run the tinyaml linter rules from ESLint with tinyaml/eslint.

tinyaml/eslint runs the linter's rules from ESLint, so eslint ., your editor, and your CI report YAML problems next to code problems.

Setup

Section titled "Setup"

Install the packages. It needs ESLint 9.15 or later and yaml-eslint-parser 2 or later, which parses the YAML for ESLint.

pnpm add -D tinyaml eslint yaml-eslint-parser

Add the recommended config to eslint.config.js:

// eslint.config.js
import tinyaml from "tinyaml/eslint";

export default [tinyaml.configs.recommended];
js

It lints **/*.{yaml,yml} and turns both rules on: tinyaml/invalid-yaml as an error, tinyaml/ambiguous-value as a warning. Then run it:

pnpm eslint .
config.yaml
  1:8  warning  `no` loads as the string "no", but YAML 1.1 readers such as PyYAML read it as a boolean. Quote it to keep the string, or write `true` or `false`  tinyaml/ambiguous-value

site.yaml
  2:10  error  tinyaml can't load this YAML: mapping keys must be strings, numbers, booleans or null. Fix the YAML at this position  tinyaml/invalid-yaml
txt

YAML that yaml-eslint-parser can't parse, such as a duplicated key, shows up as an ESLint parsing error instead of under tinyaml/invalid-yaml.

Turn a rule off or up

Section titled "Turn a rule off or up"

Set the rule in rules after the recommended config:

// eslint.config.js
import tinyaml from "tinyaml/eslint";

export default [
  tinyaml.configs.recommended,
  {
    files: ["**/*.{yaml,yml}"],
    rules: { "tinyaml/ambiguous-value": "error" },
  },
];
js

To lint other files, such as .yaml.tmpl, copy the config with your own files:

export default [{ ...tinyaml.configs.recommended, files: ["**/*.yaml.tmpl"] }];
js