README

PHP编码规范修复器

PHP编码规范修复器（PHP CS Fixer）工具可以将您的代码修复为遵循标准；无论是想遵循PSR-1、PSR-2等PHP编码标准，还是其他社区驱动的标准，如Symfony。您还可以通过配置定义您（团队）的风格。

它可以使您的代码现代化（例如将PHP 5.6中的pow函数转换为**运算符）并（微）优化它。

如果您已经使用代码检查器来识别代码中的编码规范问题，您知道手动修复它们是枯燥的，尤其是在大型项目中。此工具不仅可以检测它们，还可以为您修复它们。

支持的PHP版本

• PHP 7.4
• PHP 8.0
• PHP 8.1
• PHP 8.2
• PHP 8.3

注意 每个新的PHP版本都需要巨大的努力来支持新的语法。这就是为什么最新的PHP版本可能尚未得到支持。如果您需要它，请考虑以任何方便的方式支持该项目，例如通过代码贡献或审查现有的PR。要在不受支持的版本上运行PHP CS Fixer，请“自行承担风险” - 利用PHP_CS_FIXER_IGNORE_ENV。

文档

安装

安装PHP CS Fixer的推荐方式是使用Composer，在您的项目中的专用composer.json文件中，例如在tools/php-cs-fixer目录中

mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer

或者使用主composer.json

composer require --dev friendsofphp/php-cs-fixer

有关更多详细信息和其他安装方法，请参阅安装说明。

使用Docker运行

您可以使用预构建的Docker镜像来运行php-cs-fixer。

docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src

$FIXER_VERSION在上面的示例中用于标识您想要使用的发布版本，该版本基于Fixer和PHP版本的组合。每个Fixer的SemVer级别和PHP版本都有不同的标签，语法为<php-cs-fixer-version>-php<php-version>。例如

• 3.57.0-php7.4
• 3.57-php8.0
• 3-php8.3

使用方法

假设您已按上述说明安装了PHP CS Fixer，您可以使用以下命令修复src目录中的PHP文件

tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src

有关更多详细信息，请参阅使用说明、内置规则列表、规则集列表和配置文件的文档。

如果您需要应用工具不支持的语言风格，您可以创建自定义规则。

编辑器集成

针对以下编辑器存在专门的插件：

• NetBeans
• PhpStorm
• Sublime Text
• Vim
• VS Code

社区

PHP CS Fixer 在 GitHub 上维护，地址为 https://github.com/PHP-CS-Fixer/PHP-CS-Fixer。欢迎在那里提交错误报告和关于新功能的想法。

您可以在 GitHub 讨论区中就项目、配置、可能的改进、想法和问题与我们联系。请访问那里！

贡献

该工具自带了许多内置修复器，但非常欢迎每个人贡献更多修复器。