1.2.2 • Published 11 months ago

yaml-eslint-parser v1.2.2

Weekly downloads
9,219
License
MIT
Repository
github
Last release
11 months ago

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.

NPM license NPM version NPM downloads NPM downloads NPM downloads NPM downloads NPM downloads Build Status Coverage Status

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",
    },
  ],
};

Advanced Configuration

The following additional configuration options are available by specifying them in parserOptions in your ESLint configuration file.

Example .eslintrc.js:

module.exports = {
  overrides: [
    {
      files: ["*.yaml", "*.yml"],
      parser: "yaml-eslint-parser",
      // Additional configuration options
      parserOptions: {
        defaultYAMLVersion: "1.2",
      },
    },
  ],
};

parserOptions.defaultYAMLVersion

Set to "1.2" or "1.1". Select the YAML version used by documents without a %YAML directive.
If not specified, If not specified, the yaml's default version option ("1.2") is used.
See https://eemeli.org/yaml/#document-options for details.

Usage for Custom Rules / Plugins

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);

Related Packages

@yysmx/eslint-config@yysmx/eslint-config-basic@lvyunlong/eslint-config@lvyunlong/eslint-config-basic@jcamp/eslint-config-basic@jiqi/eslint-config@jiqi/eslint-config-basic@kaivanwong/eslint-config-base@rjqh/eslint-config-basic@rain-star/eslint-config-basic@cyenoch/eslint-config@obvcloud/eslint-config-preset-basic@denverzh/eslint-config@denverzh/eslint-config-base@nexhome/restrictions@praburangki/eslint-config-basic@zguolee/eslint-config-basic@liuxy0551/eslint-config-dtstack-basic@nplus-cumt/eslint-config-basic@ventjs/eslint-config-basic@ixfe/eslint-config-basic@silence94/eslint-config-basic@jady/eslint-config@caryhu/eslint-config-basicgang-eslint-config@fellwork/eslint-config-core@fellwork/eslint-config-foreman@easy-going/eslint-config-base@progressivestudio/eslint-config-base@progressivestudio/eslint-config-ts@chris-zhu/eslint-config-basic@venable/eslint-config@gangw/eslint-config@infinitebrahmanuniverse/nolb-yam@kriszu/eslint-config-basic@soybeanjs/eslint-config-basic@trpl/eslint-config-common@asasinmode/eslint-config-basic@tgarif/eslint-config-basiceslint-config-soybeanjs-baseeslint-config-myna@everything-registry/sub-chunk-3196@lvjiaxuan/eslint-config-js@ifmini/eslint-config@ifshizuku/eslint-config-basic@ventsislavnikolov/eslint-config@daopk/eslint-config-yaml@tttiga/eslint-config@andrskr/eslint-config@adekang/eslint-config@adekang/eslint-config-basic@alvarosabu/eslint-config-base@alwynou/eslint-config@alwynou/eslint-config-basic@asd55667/eslint-config@arthurdanjou/eslint-config-basic@alexigasse/eslint-config@alteredgraphite/eslint-config-basic@alqmc/eslint-config@alqmc/eslint-config-basic@2030/eslint-config@2030/eslint-config-basic@9x3l6/eslint-config-basic@aaronghx/eslint-config@aaronghx/eslint-config-basic@abrahamsaanchez/eslint-config@accour/eslint-config-basic@acaleph/eslint-config@acaleph/eslint-config-basic@ajiu9/eslint-config-basic@alexzhang1030/eslint-config-basic@alexzzz/eslint-config-basic@azuradara/eslint-config-basebisnow-eslint-config@caryhu/eslint-config@beiye/eslint-config@beiye/eslint-config-basic@basonwoo/eslint-config@basonwoo/eslint-config-basic@beetl/eslint-config@cyenoch/eslint-config-basic@damilaredev/eslint-config-basic@daguanren21/eslint-config@dark15/eslint-config@dark15/eslint-config-basic@danielgdev/eslint-config@danielgdev/eslint-config-basic@cxygg/eslint-config@curev/eslint-config@curev/eslint-config-basic@cyril_m/eslint-config@cyril_m/eslint-config-basic@datyin/eslint-config@dcwjoy/eslint-config@dcwjoy/eslint-config-basic@designcode/eslint-config@designcode/eslint-config-basic@depeng0929/eslint-config-basic@depeng9527/eslint-config@depeng9527/eslint-config-basic
1.2.0

1 year ago

1.2.2

11 months ago

1.2.1

11 months ago

1.1.0

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

1.0.0-beta.0

2 years ago

1.0.0-beta.1

2 years ago

0.5.0

2 years ago

0.4.1

3 years ago

0.4.0

3 years ago

0.3.0

3 years ago

0.3.2

3 years ago

0.3.1

3 years ago

0.2.2

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.1.0

3 years ago

0.0.8

4 years ago

0.0.5

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago

0.0.0

4 years ago