使用编码标准的最简单方法

<br>

主要特点

• 可安装在任何 PHP 7.2-PHP 8.3 项目上，无论依赖关系如何
• 默认支持并行运行，速度极快
• 可使用 PHP_CodeSniffer 或 PHP-CS-Fixer - 任君选择
• 使用预设规则集和 PHP CS Fixer 规则集以节省时间

<br>

安装

composer require symplify/easy-coding-standard --dev

<br>

使用

vendor/bin/ecs

首次运行时，ECS 会创建一个 ecs.php 配置文件，其中包含目录和第一条规则以开始使用。

然后您可以再次运行以查看建议的差异：

vendor/bin/ecs

要实际修复您的代码，请添加 --fix：

vendor/bin/ecs --fix

就这么简单！

<br>

配置

大多数情况下，默认配置就能满足需求。最相关的部分是配置路径、检查器和规则集：

use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
use PhpCsFixer\Fixer\ListNotation\ListSyntaxFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withConfiguredRule(
        ArraySyntaxFixer::class,
        ['syntax' => 'long']
    )
    ->withRules([
        ListSyntaxFixer::class,
    ])
    ->withPreparedSets(psr12: true);

<br>

您想检查根目录中的所有 *.php 文件（如 ecs.php、rector.php 等）吗？无需一一列举，使用 ->withRootFiles() 方法：

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withRootFiles();

<br>

您想包含 php-cs-fixer 中的 44 个规则集之一吗？

可以这样做：

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withPhpCsFixerSets(perCS20: true, doctrineAnnotation: true);

<br>

如何跳过文件/规则？

喜欢规则集，但想跳过单个规则或某些文件？

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withSkip([
        // 跳过单个规则
        ArraySyntaxFixer::class,

        // 在特定路径下跳过单个规则
        ArraySyntaxFixer::class => [
            __DIR__ . '/src/ValueObject/',
        ],

        // 通过绝对路径或 * 通配符跳过目录
        __DIR__ . '/src/Migrations',

        // 通过通配符跳过目录
        __DIR__ . '/src/*/Legacy',
    ]);

<br>

不太常用的选项

您可能不会使用这些选项，但它们可以让您对内部流程有更多控制：

use Symplify\EasyCodingStandard\Config\ECSConfig;
use Symplify\EasyCodingStandard\ValueObject\Option;

return ECSConfig::configure()
    // 要扫描的文件扩展名
    ->withFileExtensions(['php'])

    // 配置缓存路径和命名空间 - 在 Gitlab CI 缓存等情况下很有用，因为 getcwd() 总是产生不同的路径
    ->withCache(
        directory: sys_get_temp_dir() . '/_changed_files_detector_tests',
        namespace: getcwd() // 规范化为目录分隔符
    )

    // 使用特定的缩进规则打印内容
    ->withSpacing(indentation: Option::INDENTATION_SPACES, lineEnding: PHP_EOL)

    // 修改并行运行
    ->withParallel(timeoutSeconds: 120, maxNumberOfProcess: 32, jobSize: 20);

上述值为默认值。

<br>

您是否在各种项目中使用 ECS？您是否希望在每个项目中以相同的方式运行它们？让我们利用 Composer scripts

这个命令会在您的 composer.json 中添加 2 个方便的脚本：

vendor/bin/ecs scripts

始终以相同的方式运行它们 - 检查代码：

composer check-cs

应用修复，运行：

composer fix-cs

<br>

控制输出格式

您可能希望使用 ECS 为第三方工具生成报告。

我们目前提供以下格式的格式化器：

• console：类似 PHP CS Fixer 的面向人类的打印输出。
• json：用于任意工具的自定义 JSON 格式。
• junit：在不同的 CI 环境中使用的 JUnit 格式。
• checkstyle：适用于 Github Action 报告。
• gitlab：用于 Gitlab 代码质量报告或 Code Climate 工具。

有关每种格式的行为信息，请参阅它们各自的实现。

<br>

常见问题

如何清除缓存？

vendor/bin/ecs --clear-cache

如何查看所有使用的规则？

vendor/bin/ecs list-checkers

需要 json 格式吗？

vendor/bin/ecs list-checkers --output-format json

<br>

如何从其他编码标准工具迁移？

您使用其他工具并想迁移吗？这很简单 - 以下是"如何操作"：

• 对于 PHP_CodeSniffer
• 以及 PHP CS Fixer。