yaml sort checker

Vérificateur de tri de fichiers YAML

Cette bibliothèque vous aide à maintenir le fichier YAML trié pour éviter les conflits de fusion inutiles.

Consultez l'article que j'ai écrit sur l'outil: gardez vos fichiers YAML triés avec un vérificateur de tri Yaml

L'exemple typique est lorsque deux développeurs enregistrent un nouveau service dans services.yml . S'ils l'ajoutent tous les deux à la fin, cela conduira sans prudence à un conflit de fusion. Cependant, lorsque les services sont triés par ordre alphabétique, la probabilité de conflit de fusion est beaucoup plus faible (car les services supplémentaires ne s'affronteront probablement pas).

Usage

1. Installez la dernière version avec composer require --dev mhujer/yaml-sort-checker
2. Créez un fichier de configuration yaml-sort-checker.yml dans le projet root avec la liste des fichiers pour la vérification, consultez l'exemple de configuration de l'application Symfony.
3. Exécutez vendor/bin/yaml-sort-checker (dépend de l'endroit où vous avez votre répertoire de bac de compositeur)
4. Exclure les touches YAML (ou même les sections entières) que vous ne voulez pas trier - par exemple, il est plus logique de les faire non triés (voir l'exemple de configuration)

Intégration phpstorm

Jusqu'à ce que le WI-35271 soit résolu, le vérificateur de tri YAML peut être intégré dans PHPStorm en utilisant la fonctionnalité de l'observateur de fichiers.

1. Ouvrir les paramètres -> Outils -> Wield Watchers
2. Ajouter un nouveau
3. Type de fichier: YAML
4. Programme: PATH_TO_YOUR_PROJECTvendorbinyaml-sort-checker.bat
5. Ouvrez d'autres options et entrez: $ProjectFileDir$ à l'annuaire en travail
6. Maintenant, lorsque vous modifiez les fichiers YAML, il exécutera le vérificateur sur chaque enregistrement de fichier et ouvrira la console en cas d'erreurs

Exigences

Fonctionne avec PHP 7.2 ou plus et Symfony 3,4 ou plus.

Soumettre des bogues et des demandes de fonctionnalités

Les bogues et la demande de fonctionnalités sont suivis sur github

Auteur

Martin Hujer

Changelog

Voir Changelog.md pour les derniers changements.