通过 Composer 脚本集成 PHP CS Fixer 可自动格式化代码,首先本地安装工具并创建 .php-cs-fixer.dist.php 配置文件定义规则,然后在 composer.json 中添加 format 和 check-style 脚本命令,实现一键修复或检查代码风格,最后可选结合 Git 钩子在提交前自动执行,确保团队代码规范统一。

要让 Composer 与 PHP CS Fixer 配合自动格式化代码,关键是通过 Composer 的脚本功能在开发流程中自动调用 PHP CS Fixer。这样可以在执行命令(如测试、提交前)时自动修复代码风格问题。
使用 Composer 在项目中全局或本地安装 PHP CS Fixer:
推荐本地安装(项目级):
composer require --dev friendsofphp/php-cs-fixer
这会将 PHP CS Fixer 安装到 vendor/bin/ 目录下,避免依赖全局环境。
在项目根目录创建 .php-cs-fixer.dist.php 文件,定义代码规范:
立即学习“PHP免费学习笔记(深入)”;
<?php
$finder = PhpCsFixer\Finder::create()
->in(__DIR__ . '/src')
->in(__DIR__ . '/tests');
return PhpCsFixer\Config::create()
->setRules([
'@PSR12' => true,
'array_syntax' => ['syntax' => 'short'],
'no_unused_imports' => true,
])
->setFinder($finder);
这个配置启用了 PSR-12 标准,并设置了短数组语法和去除无用导入。
在 composer.json 中添加脚本,方便调用或自动触发:
"scripts": {
"format": "php-cs-fixer fix",
"check-style": "php-cs-fixer fix --dry-run --diff"
}现在可以通过以下命令格式化代码:
composer format:自动修复所有不符合规范的文件composer check-style:检查但不修改,适合 CI 环境可以结合 Git 钩子,在提交代码前自动格式化:
使用工具如 composer/package-versions-deprecated 或 phpro/grumphp 更好地集成,但简单场景可用 Composer 脚本配合 Husky(通过 Node)或直接写 Git hook 调用 composer format。
基本上就这些。Composer 结合 PHP CS Fixer 能有效统一团队代码风格,只需简单配置脚本和规则,就能实现自动化格式化。不复杂但容易忽略的是保持配置文件版本控制,确保团队一致。
以上就是composer如何与PHP CS Fixer配合自动格式化代码?的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号