friendsofphp/php-cs-fixer

自动修复PHP代码风格的工具

资助包维护!
keradus

安装量: 158,232,339

依赖: 18,059

建议者: 65

安全性: 0

星标: 12,789

关注者: 211

分支: 1,578

开放问题: 148

类型:应用程序

v3.64.0 2024-08-30 23:09 UTC

This package is auto-updated.

Last update: 2024-09-19 10:32:53 UTC


README

PHP CS Fixer logo

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

有关更多信息、内置规则列表、规则集列表和配置文件文档,请参阅用法内置规则规则集配置文件

如果您需要应用工具不支持的模式,您可以创建自定义规则

编辑器集成

以下编辑器都有专门的插件:

社区

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

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

贡献

该工具附带了许多内置修复器,但每个人都可以欢迎贡献更多