https://www.leanku.com/tags/php-cs-fixer/Recent content in PHP-CS-Fixer on Leanku 的博客Hugozh-cnSat, 10 Aug 2024 00:00:00 +0000https://www.leanku.com/post/php/composer-cs-fix-php-cs-fixer/Sat, 10 Aug 2024 00:00:00 +0000https://www.leanku.com/post/php/composer-cs-fix-php-cs-fixer/<h1 id="composer-cs-fix--代码风格修复工具-php-cs-fixer">composer cs-fix —— 代码风格修复工具 PHP-CS-Fixer</h1> <h2 id="1-什么是-php-cs-fixer">1. 什么是 PHP-CS-Fixer？</h2> <p>PHP-CS-Fixer 是由 Symfony 创始人 Fabien Potencier 发起的代码风格自动修复工具，是 PHP 生态中最主流的代码风格工具。</p> <p>这个工具的核心价值在于：<strong>不仅检测代码风格问题，还能自动修复它们</strong>。在团队协作中，它能有效消除因个人编码习惯差异导致的风格冲突，让开发者把精力集中在业务逻辑而非格式调整上。</p> <p>PHP-CS-Fixer 内置了丰富的规则集，包括：</p> <ul> <li><code>@PSR12</code>：PHP-FIG 官方推荐的最新编码标准</li> <li><code>@Symfony</code>：Symfony 框架代码风格</li> <li><code>@PhpCsFixer</code>：工具自身使用的严格规范</li> <li><code>@PER-CS</code>：现代化 PHP 编码标准</li> <li><code>@PHP82Migration</code>：PHP 8.2 迁移规则</li> </ul> <h2 id="2-适用场景">2. 适用场景</h2> <table> <thead> <tr> <th>场景</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>Git Pre-commit Hook</strong></td> <td>提交前自动格式化暂存文件，阻止风格不合规的代码进入仓库</td> </tr> <tr> <td><strong>CI/CD 流水线</strong></td> <td>在 Pull Request 中自动检查代码风格，不通过则阻止合并</td> </tr> <tr> <td><strong>团队协作</strong></td> <td>统一团队成员的编码风格，消除无意义的格式争论</td> </tr> <tr> <td><strong>遗留项目格式化</strong></td> <td>一键格式化整个代码库，快速建立统一标准</td> </tr> <tr> <td><strong>IDE 集成</strong></td> <td>在 PhpStorm 等 IDE 中实现保存即格式化</td> </tr> </tbody> </table> <blockquote> <p><strong>最佳实践</strong>：配置分为两个层级——<code>composer cs-check</code>（仅检查，不修改）用于 CI 流程；<code>composer cs-fix</code>（实际修复）用于本地开发。</p> </blockquote> <h2 id="3-安装与初始化">3. 安装与初始化</h2> <h3 id="31-通过-composer-安装推荐">3.1 通过 Composer 安装（推荐）</h3> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">composer require --dev friendsofphp/php-cs-fixer </span></span></code></pre></div><p>如果遇到依赖冲突，可以使用官方提供的 Shim 包：</p>