PHP-CS-Fixer/PHP-CS-Fixer

GitHub: PHP-CS-Fixer/PHP-CS-Fixer

一个自动修复 PHP 编码规范问题的工具,帮助开发团队轻松统一代码风格并顺利完成代码现代化迁移。

Stars: 13508 | Forks: 1628

PHP CS Fixer logo

# PHP Coding Standards Fixer PHP Coding Standards Fixer (PHP CS Fixer) 能够修复你的代码以使其符合标准。 如果你已经在使用代码检查工具来发现代码中的编码规范问题, 你就会知道手动修复这些问题是非常乏味的,尤其是在大型 项目中。这个工具不仅能检测这些问题,还能自动帮你修复它们。 PHP CS Fixer 内置了多种规则集,无论你是想遵循由 [PHP-FIG 的 PER 编码风格](https://www.php-fig.org/per/coding-style/) 定义的 PHP 编码规范 - [`@PER-CS`](./doc/ruleSets/PER-CS.rst), 像 [Symfony](https://symfony.com/doc/current/contributing/code/standards.html) 这样广泛社区制定的规范 - [`@Symfony`](./doc/ruleSets/Symfony.rst), 还是我们自己推荐的规范 - [@PhpCsFixer](./doc/ruleSets/PhpCsFixer.rst)。 你也可以通过[配置文件](./doc/config.rst)来定义你(或你的团队)的代码风格。 PHP CS Fixer 不仅能统一你的代码风格,还能帮助你的代码库向 更新版本的 PHP(例如 [`@autoPHPMigration`](./doc/ruleSets/AutoPHPMigration.rst) 和 [`@autoPHPMigration:risky`](./doc/ruleSets/AutoPHPMigrationRisky.rst))以及更新版本的 PHPUnit(例如 [`@autoPHPUnitMigration:risky`](./doc/ruleSets/AutoPHPUnitMigrationRisky.rst))进行现代化升级。 此外还有 [`@auto`](./doc/ruleSets/Auto.rst) 和 [`@auto:risky`](./doc/ruleSets/AutoRisky.rst),它们旨在提供良好的基础规则。 ## 支持的 PHP 版本 * PHP 7.4 - PHP 8.5 ## 文档 ### 安装 安装 PHP CS Fixer 的推荐方式是使用 [Composer](https://getcomposer.org/download/): ``` composer require --dev friendsofphp/php-cs-fixer ## 或在依赖项中遇到冲突时: composer require --dev php-cs-fixer/shim ``` 有关更多详细信息和其他安装方法(包括使用 Docker 或在 CI 环境中安装),请参阅 [安装说明](./doc/installation.rst)。 ### 用法 假设你已按照上述说明安装了 PHP CS Fixer,你可以 使用以下命令为你的项目初始化基础配置: ``` ./vendor/bin/php-cs-fixer init ``` 要自动修复你的项目,或仅检查是否需要修改,请运行: ``` ./vendor/bin/php-cs-fixer fix ./vendor/bin/php-cs-fixer check ``` 有关更多详细信息,请参阅[用法](./doc/usage.rst)、[内置规则](./doc/rules/index.rst)列表、[规则集](./doc/ruleSets/index.rst)列表 和[配置文件](./doc/config.rst)文档。 如果你需要应用该工具未内置的代码风格,你可以 [创建自定义规则](./doc/custom_rules.rst)。 ## 编辑器集成 原生支持: * [PhpStorm](https://www.jetbrains.com/help/phpstorm/using-php-cs-fixer.html) 社区插件支持: * [NetBeans](https://plugins.netbeans.apache.org/catalogue/?id=36) * [Sublime Text](https://github.com/benmatselby/sublime-phpcs) * [Vim](https://github.com/stephpy/vim-php-cs-fixer) * [VS Code](https://github.com/junstyle/vscode-php-cs-fixer) ## 社区 PHP CS Fixer 在 GitHub 上进行维护,地址为 。 我们欢迎在此贡献代码、提交错误报告以及提出有关新功能的想法。 你可以在 [GitHub Discussions](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/) 中就 项目、配置、可能的改进、想法和问题与我们交流。 ## 贡献 该工具附带了不少内置修复器,但我们非常 欢迎大家[贡献](./CONTRIBUTING.md)更多的修复器。
标签:Composer, ffuf, Linter, OpenVAS, PER Coding Style, PHP, PHP CS Fixer, PHP-FIG, PHPUnit, pptx, SOC Prime, Symfony, 代码审查, 代码格式化, 代码美化, 代码规范, 单元测试, 开发工具, 网络调试, 自动修复, 自动化, 重构, 错误基检测, 静态代码分析