mhujer / yaml-sort-checker
YAML 排序检查器用于检查您的 YML 文件是否已正确排序,以防止合并冲突
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
README
此库帮助您保持 YAML 文件的排序,以防止不必要的合并冲突。
查看我关于此工具的文章: 使用 YAML 排序检查器保持 YAML 文件排序
典型示例是当两个开发者同时在 services.yml
中注册新的服务。如果他们都将其添加到末尾,不可避免地会导致合并冲突。然而,当服务按字母顺序排序时,合并冲突的概率要低得多(因为添加的服务可能不会冲突)。
使用方法
- 使用
composer require --dev mhujer/yaml-sort-checker
安装最新版本 - 在项目根目录中创建一个配置文件
yaml-sort-checker.yml
,其中包含要检查的文件列表,请参阅Symfony 应用程序的示例配置。 - 运行
vendor/bin/yaml-sort-checker
(取决于您的 Composer bin 目录的位置) - 排除您不希望排序的 yaml 键(甚至整个部分)- 例如,不排序它们更有意义(请参阅示例配置)
PHPStorm 集成
在 WI-35271 得到解决之前,可以通过使用文件监视器功能将 YAML 排序检查器集成到 PHPStorm 中。
- 打开设置 -> 工具 -> 文件监视器
- 添加新项
- 文件类型:
YAML
- 程序:
PATH_TO_YOUR_PROJECT\vendor\bin\yaml-sort-checker.bat
- 打开 其他选项 并输入:
$ProjectFileDir$
到 工作目录 - 现在,当您编辑 YAML 文件时,它将在每次文件保存时运行检查器,如果存在错误,则会打开控制台
要求
支持 PHP 7.2 或更高版本以及 Symfony 3.4 或更高版本。
提交错误和功能请求
错误和功能请求在 GitHub 上跟踪
作者
变更日志
查看 CHANGELOG.md 了解最新更改。