mavsolutions/yaml-linter

A Symfony cli command utility for checking YAML file syntax

Maintainers

Details

github.com/mavolkmer/yaml-linter

Homepage

Source

Issues

Installs: 72

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

pkg:composer/mavsolutions/yaml-linter

1.0.0 2025-09-19 08:03 UTC

Requires

Requires (Dev)

GPL-2.0-or-later ed9012d37cea5e9788925da2ed730988c3decf7f

symfonyyamlcliutilitysyntaxymllint

This package is auto-updated.

Last update: 2025-10-19 08:20:28 UTC

README

Wrapper for symfony/yaml's LintCommand (see Symfony/Yaml)

Call it like Symfony's LintCommand with filename as arguments, single files as exclude-Option and with additional option excludePattern.
ExcludePattern are parsed with symfony/finder (see Symfony/Finder) as path and all matching yaml|yml are added to LintCommand's exclude-options.

use-case

In some projects one might use local composer-packages which have their own frontend-buildchain. This buildchain might integrate some third-party libraries into your project-structure with malformed yaml-files which you don't need to care for.

├── composer.json
├── src
…
└── packages
    └── local-subpackage
        ├── composer.json
        ├── Configuration
        ├── Documentation
        ├── Resources
        │   ├── node_modules
        │   │   ├── some third party npm-packages
        │   │   └── …
        │   ├── package.json
        │   ├── Sources
        │   ├── webpack.config.js
        │   └── yarn.lock
        …

When scanning this whole project with a yaml-lint-command I got some errors from node_modules-subdirectories. You should for sure validate those error-messages, create several pull-requests to the third-party repos, patch your local files while waiting for pr to be merged - but to be honest in real life you only need a "green pipeline".

Example

vandor/bin/yaml-linter src --excludePattern=thirdParty