README

该库帮助修复PHP代码，使其符合 Paysera PHP风格指南。

安装

先决条件

• 将脚本 Paysera\\PhpCsFixerConfig\\Composer\\PhpCsFixerConfigProvider::copyPhpCs 添加到 post-install-cmd 和 post-update-cmd 或其他 scripts 中 - 确保该脚本在 composer install 时执行。

安装并检查

• composer require --dev paysera/lib-php-cs-fixer-config.
• 确保 php-cs-fixer.php 文件位于项目目录中。

由于此库附带修复器的二进制版本，无需单独安装php-cs-fixer。这避免了在项目中需要其依赖项，可能会与现有的依赖项冲突。

为了避免与php-cs-fixer库重复，它被命名为 paysera-php-cs-fixer。

php-cs-fixer.php 文件

• php-cs-fixer.php - 所有Paysera推荐的修复器。
• php-cs-fixer-risky.php - 除建议外（注释警告）的所有高风险修复器。
• php-cs-fixer-safe.php - 所有非高风险修复器。

迁移模式

对于新项目，您可以像往常一样使用所有规则。

对于现有项目，我们建议开启迁移模式

1. 将 enableMigrationMode([]) 调用添加到您的 php-cs-fixer.php 文件中的 PayseraConventionsConfig 实例。
2. 运行 {your-bin-dir}/php-cs-fixer - 它将使用初始规则配置提供错误，将其复制粘贴到您的 php-cs-fixer.php 文件中。
3. 启用一个规则，在项目中应用修复，审查和测试它们。
4. 对每个新规则重复此过程。

这允许您控制项目中启用的规则，从而手动调整已应用的修复并强制新代码。您的提交将更加集中，因为每个提交都仅包含单个修复器的更改。

所有规则都应配置为允许轻松地查找核心中添加（或删除）的新规则。

与测试一起运行修复器

对于开发者注释或建议，应使用包含所有规则的默认 php-cs-fixer.php 文件。

对于自动检查，可能会有一些假阳性，因此在这种情况下应使用 php-cs-fixer-risky.php。

您可以在本存储库中的 .travis.yml 文件中查看集成travis的示例（这将只为更改的文件运行检查）。

使用方法

在项目目录中通过以下命令运行： {your-bin-dir}/php-cs-fixer fix /path/to/code --verbose --dry-run --diff

使用 --config=.php-cs-fixer.php 标志进行自定义配置。

如果未定义 /path/to/code，则 php-cs-fixer 将运行默认 src 目录中的文件，排除 Test 文件夹。

--verbose - 显示应用的规则。当使用txt格式时，它还将显示进度通知。

--dry-run 和 --diff 的组合将显示建议的修复的摘要，而不会更改您的文件。

--format 选项用于输出格式。支持的格式有 txt（默认格式）、json、xml 和 junit。

更多信息： PHP CS Fixer