composer怎么安装php-cs-fixer并配置scripts-composer-PHP中文网

composer怎么安装php-cs-fixer并配置scripts

穿越時空

发布： 2025-10-15 10:52:01

原创

775人浏览过

安装PHP CS Fixer后配置composer.json脚本可实现代码风格自动化，通过cs:fix修复、cs:check检查，结合自定义规则文件统一规范。

composer怎么安装php-cs-fixer并配置scripts

PHP CS Fixer 是一个非常流行的 PHP 代码风格修复工具，可以帮助你自动格式化代码以符合 PSR-12 等编码规范。通过 Composer 安装并配置到 `scripts` 中，可以方便地在项目中统一执行代码格式化。

安装 PHP CS Fixer

在项目根目录下运行以下命令，使用 Composer 安装 friendsofphp/php-cs-fixer 作为开发依赖：

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

安装完成后，可执行文件会位于 vendor/bin/php-cs-fixer，你可以通过 ./vendor/bin/php-cs-fixer -V 验证是否安装成功。

配置 composer.json 的 scripts

为了更方便地调用 PHP CS Fixer，可以在 composer.json 中添加自定义脚本。打开 composer.json 文件，在 "scripts" 部分添加如下内容：

{
    "scripts": {
        "cs:fix": "php-cs-fixer fix",
        "cs:check": "php-cs-fixer fix --dry-run --diff"
    }
}

登录后复制

cs:fix：自动修复代码风格问题
cs:check：只检查不修改，用于 CI 环境判断是否符合规范

添加后，就可以使用以下命令：

立即学习“PHP免费学习笔记（深入）”；

琅琅配音

全能AI配音神器

208

查看详情

composer cs:fix
composer cs:check

可选：添加配置文件

在项目根目录创建 .php-cs-fixer.php 文件（或 .php_cs.dist），用于定义代码规范规则：

<?php

return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'ordered_imports' => true,
        'no_unused_imports' => true,
    ])
    ->setFinder(
        PhpCsFixer\Finder::create()
            ->in(__DIR__ . '/src')
            ->in(__DIR__ . '/tests')
    );

登录后复制

这样，fix 命令会根据你的规则自动处理指定目录下的文件。