yaml sort checker

Verificador de classificação de arquivos yaml

Esta biblioteca ajuda você a manter o arquivo YAML classificado para evitar conflitos desnecessários de mesclagem.

Confira o artigo que escrevi sobre a ferramenta: mantenha seus arquivos YAML classificados com o verificador de classificação YAML

Exemplo típico é quando dois desenvolvedores registram um novo serviço em services.yml . Se os dois adicionarem até o fim, isso de forma inevitável levará a um conflito de mesclagem. No entanto, quando os serviços são classificados em ordem alfabética, a probabilidade de conflito de mesclagem é muito menor (porque os serviços adicionados provavelmente não se chocam).

Uso

1. Instale a versão mais recente com composer require --dev mhujer/yaml-sort-checker
2. Crie um arquivo de configuração yaml-sort-checker.yml no Project Root com a lista dos arquivos para verificação, consulte a configuração de exemplo para o aplicativo Symfony.
3. Execute vendor/bin/yaml-sort-checker (depende de onde você tem seu diretório de bin compositor)
4. Exclua as teclas YAML (ou mesmo seções inteiras) que você não deseja classificar - por exemplo, faz mais sentido tê -las não classificadas (veja a configuração de exemplo)

Integração de Phpstorm

Até que o WI-35271 seja resolvido, o verificador de classificação da YAML pode ser integrado ao PHPStorm usando o recurso Observador de arquivos.

1. Abrir configurações -> Ferramentas -> Vigilantes do arquivo
2. Adicione novo
3. Tipo de arquivo: YAML
4. Programa: PATH_TO_YOUR_PROJECTvendorbinyaml-sort-checker.bat
5. Abra outras opções e digite: $ProjectFileDir$ para Diretório de Trabalho
6. Agora, quando você estiver editando arquivos YAML, ele executará o verificador em todos os arquivos salvar e abrirá o console se houver erros

Requisitos

Funciona com Php 7.2 ou superior e Symfony 3.4 ou superior.

Enviando bugs e solicitações de recursos

Bugs e solicitação de recurso são rastreados no GitHub

Autor

Martin Hujer

Changelog

Consulte Changelog.md para obter as últimas alterações.