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

安装 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免费学习笔记(深入)”;
composer cs:fixcomposer cs:check
可选:添加配置文件
在项目根目录创建 .php-cs-fixer.php 文件(或 .php_cs.dist),用于定义代码规范规则:
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 命令会根据你的规则自动处理指定目录下的文件。
小贴士
- 建议将 php-cs-fixer 加入开发流程,比如 Git Hook 或 CI/CD 中
- 如果团队多人协作,确保每个人都使用相同版本的 PHP CS Fixer,避免格式差异
- 可以通过 composer bin php-cs-fixer info 查看二进制路径和版本











