Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ota-meshi/yaml-eslint-parser
A YAML parser that produces output compatible with ESLint
https://github.com/ota-meshi/yaml-eslint-parser
ast eslint eslint-custom-parser eslint-parser yaml-parser
Last synced: 6 days ago
JSON representation
A YAML parser that produces output compatible with ESLint
- Host: GitHub
- URL: https://github.com/ota-meshi/yaml-eslint-parser
- Owner: ota-meshi
- License: mit
- Created: 2020-07-29T05:23:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T11:19:10.000Z (7 months ago)
- Last Synced: 2024-05-01T21:19:21.138Z (6 months ago)
- Topics: ast, eslint, eslint-custom-parser, eslint-parser, yaml-parser
- Language: TypeScript
- Homepage: https://ota-meshi.github.io/yaml-eslint-parser/
- Size: 1.23 MB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# yaml-eslint-parser
A YAML parser that produces output [compatible with ESLint](https://eslint.org/docs/developer-guide/working-with-custom-parsers#all-nodes).
_This parser is backed by excellent [yaml](https://github.com/eemeli/yaml) package and it is heavily inspired by [yaml-unist-parser](https://github.com/ikatyang/yaml-unist-parser) package._
[](https://www.npmjs.com/package/yaml-eslint-parser)
[](https://www.npmjs.com/package/yaml-eslint-parser)
[](http://www.npmtrends.com/yaml-eslint-parser)
[](http://www.npmtrends.com/yaml-eslint-parser)
[](http://www.npmtrends.com/yaml-eslint-parser)
[](http://www.npmtrends.com/yaml-eslint-parser)
[](http://www.npmtrends.com/yaml-eslint-parser)
[](https://github.com/ota-meshi/yaml-eslint-parser/actions?query=workflow%3ACI)
[](https://coveralls.io/github/ota-meshi/yaml-eslint-parser?branch=master)
## Installation
```bash
npm install --save-dev yaml-eslint-parser
```
## Usage
### Configuration
Use `.eslintrc.*` file to configure parser. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
Example **.eslintrc.js**:
```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](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options) in your ESLint configuration file.
Example **.eslintrc.js**:
```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, the [yaml](https://eemeli.org/yaml/)'s default `version` option (`"1.2"`) is used.
See for details.
## Usage for Custom Rules / Plugins
- [AST.md](./docs/AST.md) is AST specification.
- [block-mapping.ts](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/block-mapping.ts) is an example.
- You can see the AST on the [Online DEMO](https://ota-meshi.github.io/yaml-eslint-parser/).
## Usage for Directly
Example:
```ts
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
- [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5.
- [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) ... ESLint plugin for YAML.
- [eslint-plugin-toml](https://github.com/ota-meshi/eslint-plugin-toml) ... ESLint plugin for TOML.
- [eslint-plugin-json-schema-validator](https://github.com/ota-meshi/eslint-plugin-json-schema-validator) ... ESLint plugin that validates data using JSON Schema Validator.
- [jsonc-eslint-parser](https://github.com/ota-meshi/jsonc-eslint-parser) ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
- [toml-eslint-parser](https://github.com/ota-meshi/toml-eslint-parser) ... TOML parser for use with ESLint plugins.