https://github.com/mhujer/yaml-sort-checker

Tool for checking if the YAML config files are alphabetically sorted
https://github.com/mhujer/yaml-sort-checker

php static-analysis symfony yaml

Last synced: about 1 month ago
JSON representation

Tool for checking if the YAML config files are alphabetically sorted

• Host: GitHub
• URL: https://github.com/mhujer/yaml-sort-checker
• Owner: mhujer
• License: mit
• Created: 2017-01-08T16:41:34.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T15:07:15.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T01:41:12.446Z (about 2 months ago)
• Topics: php, static-analysis, symfony, yaml
• Language: PHP
• Size: 103 KB
• Stars: 23
• Watchers: 5
• Forks: 11
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# YAML file sort checker [![Build Status](https://travis-ci.org/mhujer/yaml-sort-checker.svg?branch=master)](https://travis-ci.org/mhujer/yaml-sort-checker)

[![Latest Stable Version](https://poser.pugx.org/mhujer/yaml-sort-checker/version.png)](https://packagist.org/packages/mhujer/yaml-sort-checker) [![Total Downloads](https://poser.pugx.org/mhujer/yaml-sort-checker/downloads.png)](https://packagist.org/packages/mhujer/yaml-sort-checker) [![License](https://poser.pugx.org/mhujer/yaml-sort-checker/license.svg)](https://packagist.org/packages/mhujer/yaml-sort-checker)

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](https://blog.martinhujer.cz/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).

![yaml-sort-checker DEMO](./docs/yaml-sort-checker-demo.png)

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](/docs/symfony-config/yaml-sort-checker.yml).

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](/docs/symfony-config/yaml-sort-checker.yml))

PHPStorm Integration

---------------------

Until [WI-35271](https://youtrack.jetbrains.com/issue/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](https://github.com/mhujer/yaml-sort-checker/issues)

Author

------

[Martin Hujer](https://www.martinhujer.cz) 

Changelog

----------

See [CHANGELOG.md](./CHANGELOG.md) for latest changes.