stevebauman / php-cs-fixer
自动修复 PHP 代码风格的工具
Requires
- php: ^7.4 || ^8.0
- ext-json: *
- ext-tokenizer: *
- composer/semver: ^3.3
- composer/xdebug-handler: ^3.0.3
- sebastian/diff: ^4.0 || ^5.0
- symfony/console: ^5.4 || ^6.0
- symfony/event-dispatcher: ^5.4 || ^6.0
- symfony/filesystem: ^5.4 || ^6.0
- symfony/finder: ^5.4 || ^6.0
- symfony/options-resolver: ^5.4 || ^6.0
- symfony/polyfill-mbstring: ^1.27
- symfony/polyfill-php80: ^1.27
- symfony/polyfill-php81: ^1.27
- symfony/process: ^5.4 || ^6.0
- symfony/stopwatch: ^5.4 || ^6.0
Requires (Dev)
- facile-it/paraunit: ^1.3 || ^2.0
- justinrainbow/json-schema: ^5.2
- keradus/cli-executor: ^2.0
- mikey179/vfsstream: ^1.6.11
- php-coveralls/php-coveralls: ^2.5.3
- php-cs-fixer/accessible-object: ^1.1
- php-cs-fixer/phpunit-constraint-isidenticalstring: ^1.2
- php-cs-fixer/phpunit-constraint-xmlmatchesxsd: ^1.2.1
- phpspec/prophecy: ^1.16
- phpspec/prophecy-phpunit: ^2.0
- phpunit/phpunit: ^9.5
- phpunitgoodpractices/polyfill: ^1.6
- phpunitgoodpractices/traits: ^1.9.2
- symfony/phpunit-bridge: ^6.2.3
- symfony/yaml: ^5.4 || ^6.0
Suggests
- ext-dom: For handling output formats in XML
- ext-mbstring: For handling non-UTF8 characters.
This package is auto-updated.
Last update: 2024-09-03 20:23:56 UTC
README
PHP 编码规范修复器
PHP 编码规范修复器 (PHP CS Fixer) 工具可以将您的代码修复为符合规范；无论是想遵循 PSR-1、PSR-2 等定义的 PHP 编码规范，还是其他社区驱动的规范，如 Symfony。您也可以通过配置定义（团队）的样式。
它可以使您的代码现代化（例如，将 PHP 5.6 中的 pow 函数转换为 ** 运算符）并（微）优化它。
如果您已经在代码中使用了代码规范问题的代码检查器，您知道手动修复它们很繁琐，尤其是在大型项目中。此工具不仅可以检测它们，还可以为您修复它们。
支持的 PHP 版本
- PHP 7.4
- PHP 8.0（由于 PHP 标识符解析器中的错误，不包括 PHP 8.0.0）
- PHP 8.1
- PHP 8.2
注意 支持每个新的 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
有关更多详细信息和其他安装方法，请参阅 安装说明。
使用方法
假设您已按上述说明安装了 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。欢迎在此处提交错误报告和关于新功能的想法。
有关项目、配置、可能的改进、想法和问题，您可以在 https://gitter.im/PHP-CS-Fixer/Lobby 联系我们，请访问我们！
贡献
此工具附带许多内置修复器，但每个人都非常欢迎 贡献 更多。