README

使 Symplify Coding Standard 的修复器与 PHP-CS-Fixer 兼容。

由于 Symplify Coding Standard 的修复器是为 EasyCodingStandard 设计的，因此它们在 PHP-CS-Fixer 配置（.php_cs 或 .php_cs.dist）中无法工作。这个库提供了一个适配层，用于在 PHP-CS-Fixer 和 Symplify Coding Standard 之间架起桥梁。

安装

composer require --dev suin/symplify-cs-fixer

用法

首先，在项目的根目录中创建一个 PHP-CS-Fixer 规则集 XML 文件（.php_cs.dist 或 .php_cs）。

<?php

declare(strict_types=1);

return PhpCsFixer\Config::create()
    ->registerCustomFixers(new SymplifyCsFixer\SymplifyCsFixers())
    ->setRules(
        [
            SymplifyCsFixer\ArrayPropertyDefaultValueFixer::NAME => true,
            SymplifyCsFixer\BlankLineAfterStrictTypesFixer::NAME => true,
            SymplifyCsFixer\BlockPropertyCommentFixer::NAME => true,
            SymplifyCsFixer\ClassStringToClassConstantFixer::NAME => true,
            SymplifyCsFixer\FinalInterfaceFixer::NAME => true,
            SymplifyCsFixer\LineLengthFixer::NAME => [
                'line_length' => 80,
                'break_long_lines' => true,
                'inline_short_lines' => true,
            ],
            SymplifyCsFixer\MethodOrderByTypeFixer::NAME => true,
            SymplifyCsFixer\ParamReturnAndVarTagMalformsFixer::NAME => true,
            SymplifyCsFixer\PrivateMethodOrderByUseFixer::NAME => true,
            SymplifyCsFixer\PropertyNameMatchingTypeFixer::NAME => true,
            SymplifyCsFixer\PropertyOrderByComplexityFixer::NAME => true,
            SymplifyCsFixer\RemoveEmptyDocBlockFixer::NAME => true,
            SymplifyCsFixer\RemoveEndOfFunctionCommentFixer::NAME => true,
            SymplifyCsFixer\RemoveSuperfluousDocBlockWhitespaceFixer::NAME => true,
            SymplifyCsFixer\RemoveUselessDocBlockFixer::NAME => true,
            SymplifyCsFixer\RequireFollowedByAbsolutePathFixer::NAME => true,
            SymplifyCsFixer\StandaloneLineInMultilineArrayFixer::NAME => true,  
        ]
    )
    // ...
    ;

然后使用以下命令运行它

vendor/bin/php-cs-fixer fix --dry-run --diff --diff-format=udiff --verbose

变更日志

有关更多详细信息，请参阅 变更日志。

贡献

向主存储库发送 问题 或 拉取请求。