使用 Composer 管理 php-cs-fixer 可实现代码风格自动化。通过 composer require –dev friendsofphp/php-cs-fixer 安装工具,并在项目根目录创建 .php-cs-fixer.php 配置文件定义规则(如启用 PSR-12、短数组语法和去除未使用 import)。在 composer.json 中添加脚本 “cs:fix” 用于自动修复,”cs:check” 用于检查差异,便于 CI 集成。建议将检查流程接入 Git 钩子或 GitHub Actions,确保代码一致性,提升团队协作效率。
使用 Composer 管理 php-cs-fixer 并自动修复代码风格是一种高效、可复用的开发实践。通过将 php-cs-fixer 作为项目依赖安装,可以确保团队成员使用相同的版本和规则,避免风格差异。
安装 php-cs-fixer
在项目根目录下运行以下命令,将 php-cs-fixer 安装为开发依赖:
composer require –dev friendsofphp/php-cs-fixer
安装完成后,可执行 vendor/bin/php-cs-fixer 来调用工具。
配置 .php-cs-fixer.php 文件
在项目根目录创建 .php-cs-fixer.php 配置文件,定义代码风格规则。示例配置如下:
立即学习“PHP免费学习笔记(深入)”;
return PhpCsFixerConfig::create()
->setRules([
‘@PSR12’ => true,
‘array_syntax’ => [‘syntax’ => ‘short’],
‘no_unused_imports’ => true,
‘not_operator_with_successor_space’ => true,
])
->setFinder(
PhpCsFixerFinder::create()
->in(__DIR__ . ‘/src’)
->in(__DIR__ . ‘/tests’)
);
?>
该配置启用了 PSR-12 规范,并设置了数组语法为短语法,同时清理未使用的 import。
添加 composer 脚本快捷方式
在 composer.json 中添加脚本,方便调用:
“scripts”: {
“cs:fix”: “php-cs-fixer fix”,
“cs:check”: “php-cs-fixer fix –dry-run –diff”
}
之后可通过以下命令快速操作:
- composer cs:fix – 自动修复代码风格
- composer cs:check – 检查但不修改,用于 CI 环境
集成到开发流程
建议将代码风格检查加入 Git 钩子或 CI/CD 流程。例如使用 composer install 后自动设置 Git pre-commit 钩子,或在 GitHub Actions 中运行 composer cs:check 防止不符合规范的代码被合并。
本地开发时,运行 composer cs:fix 即可一键修复所有可修正的问题,提升代码一致性。
基本上就这些。用 Composer 管理 php-cs-fixer 让代码风格自动化变得简单可靠。
php js git json composer github 工具 配置文件 php composer json require github git 自动化