j13k / yaml-lint
A compact command line utility for checking YAML file syntax
Installs: 1 009 878
Dependents: 22
Suggesters: 0
Security: 0
Stars: 14
Watchers: 4
Forks: 7
Open Issues: 3
Requires
- php: >=5.6
- composer-runtime-api: ^2
- ext-json: *
- symfony/yaml: ^2 || ^3 || ^4 || ^5 || ^6 || ^7
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-29 09:03:52 UTC
README
A compact command line linting tool for validating YAML files, using the parsing facility of the Symfony Yaml Component.
Usage
usage: yaml-lint [options] [input source]
input source Path to file(s), or "-" to read from standard input
-q, --quiet Restrict output to syntax errors
-h, --help Display this help
-V, --version Display application version
Install
Composer
To get started using yaml-lint in a project, install it with Composer:
composer require --dev j13k/yaml-lint
It can then be run from the project's vendor/bin directory.
To set up yaml-lint globally, install it in the Composer home directory:
composer global require j13k/yaml-lint
It can then be run from the bin directory of Composer home (typically ~/.composer/vendor/bin).
Binary
A binary edition , yaml-lint.phar, is available for download
with each release. This embeds the latest stable version of the Symfony
Yaml component that is current at the time of the release.
The binary can be conveniently installed using PHIVE:
phive install yaml-lint
Docker
yaml-lint is bundled in the phpqa Docker image, which provides a suite of static analysis tools for PHP. See the phpqa project for installation and usage instructions.
Change log
Please see CHANGELOG for information on what has changed recently.
Credits
License
The MIT License (MIT). Please see LICENCE for more information.