YAML
An ESLint plugin that provides linting rules for YAML files, including support for Vue SFC custom blocks and ESLint directives.
What is YAML?
eslint-plugin-yml is an ESLint plugin that provides linting rules for YAML files. It enables developers to find problems, enforce consistent code styles, and apply real-time checks using ESLint's ecosystem, helping maintain clean and error-free configuration files, documentation, and data serialization.
Developers and teams working with YAML files in projects such as configuration management (e.g., GitHub Actions, Docker Compose), documentation, or Vue.js Single File Components with i18n custom blocks. It is particularly useful for those already using ESLint and seeking to extend its benefits to YAML.
Unlike other YAML linting plugins, eslint-plugin-yml provides AST and source code text to ESLint, enabling compatibility with ESLint directives (e.g., # eslint-disable), other ESLint plugins (like eslint-plugin-prettier), and rules that require text analysis. It also offers shareable configs and supports Vue SFC custom blocks.
Overview
This ESLint plugin provides linting rules for YAML.
Use Cases
Best For
- Linting YAML configuration files in CI/CD pipelines to enforce style and prevent errors.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
