mhujer/yaml-sort-checker

YAML sort checker checks if your YML files are properly sorted to prevent merge conflicts

1.5.0 2020-11-30 23:28 UTC

Requires

• php: ~7.3 | ^8.0
• symfony/console: ~3.4|~4.3|~5.0
• symfony/yaml: ~3.4|~4.3|~5.0

Requires (Dev)

• consistence/coding-standard: 3.10.1
• php-parallel-lint/php-parallel-lint: 1.2.0
• phpstan/phpstan: 0.12.57
• phpunit/phpunit: 9.4.3
• slevomat/coding-standard: 6.4.1

MIT

• Martin Hujer

• yaml
• sorter

README

This library helps you to keep YAML file sorted to prevent unnecessary merge conflicts.

Check out the article I've written about the tool: Keep your YAML files sorted with YAML sort checker

Typical example is when two developers register a new service in services.yml. If they both add it to the end, it unevitably will lead to a merge conflict. However, when the services are alphabetically sorted, the probability of merge conflict is much lower (because the added services probably won't clash).

Usage

1. Install the latest version with composer require --dev mhujer/yaml-sort-checker
2. Create a configuration file yaml-sort-checker.yml in project root with list of the files for checking, see the example configuration for Symfony app.
3. Run vendor/bin/yaml-sort-checker (depends on where you have your Composer bin directory)
4. Exclude the yaml keys (or even whole sections) you don't want to sort - e.g. it makes more sense to have them unsorted (see the example configuration)

PHPStorm Integration

Until WI-35271 is resolved, YAML sort checker can be integrated into PHPStorm by using File Watcher feature.

1. Open Settings -> Tools -> File Watchers
2. Add new
3. File type: YAML
4. Program: PATH_TO_YOUR_PROJECT\vendor\bin\yaml-sort-checker.bat
5. Open Other Options and enter: $ProjectFileDir$ to Working directory
6. Now, when you are editing YAML files, it will run the checker on every file save and will open the console if there are errors

Requirements

Works with PHP 7.2 or higher and Symfony 3.4 or higher.

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub

Author

Martin Hujer

Changelog

See CHANGELOG.md for latest changes.