Composer 本身不提供代码规范检查能力,但可通过 scripts 配置集成 php-cs-fixer:需 dev 安装、在 scripts 中定义 cs:check/cs:fix 命令、限定 src/ 和 tests/ 路径、确保配置文件位于根目录且命名正确。

Composer 本身不提供代码规范检查能力,但可以通过 scripts 配置项集成 php-cs-fixer 或 phpcbf 等工具,在 composer install、composer run 等生命周期中自动执行检查或修复。
如何在 composer.json 中注册 php-cs-fixer 检查脚本
核心是把 php-cs-fixer 命令注册为 Composer 的自定义脚本,并确保它能被正确调用。常见错误是路径不对、未安装依赖、或未指定配置文件。
-
php-cs-fixer必须作为require-dev安装:composer require --dev friendsofphp/php-cs-fixer
- 在
composer.json的"scripts"下添加命名脚本,例如:"scripts": { "cs:check": "php-cs-fixer fix --dry-run --diff", "cs:fix": "php-cs-fixer fix" } - 运行时使用:
composer run cs:check(检查不修改)或composer run cs:fix(自动修复) - 若项目根目录无
.php-cs-fixer.php或.php_cs,php-cs-fixer会回退到内置规则集;建议显式配置,避免团队行为不一致
为什么 php-cs-fixer 不生效?常见路径与权限问题
脚本报错 Command "php-cs-fixer" is not defined 或直接找不到命令,通常不是 Composer 配置问题,而是二进制可执行文件未被识别。
- 确认
vendor/bin/php-cs-fixer文件存在且有可执行权限(Linux/macOS 下用ls -l vendor/bin/php-cs-fixer查看) - Windows 用户注意:Composer 脚本在 cmd/PowerShell 中可能无法直接调用
vendor/bin/php-cs-fixer,应改用php vendor/bin/php-cs-fixer形式 - 若用 Docker 或 CI 环境,需确保 PHP CLI 版本 ≥
php-cs-fixer所需最低版本(如 v3.20+ 要求 PHP 7.4+) - 某些 IDE(如 PhpStorm)的终端未加载 Composer 的
vendor/bin到$PATH,导致手动运行失败,但composer run内部仍可工作
如何让 CS 检查只作用于 src/ 和 tests/ 目录
默认 php-cs-fixer 会扫描整个项目(包括 vendor/),必须通过参数限定范围,否则 CI 构建慢、误报多。
立即学习“PHP免费学习笔记(深入)”;
- 修改脚本命令,加入
--path-mode=intersection和显式路径:"cs:check": "php-cs-fixer fix --dry-run --diff --path-mode=intersection src/ tests/"
- 也可用
--exclude排除不需要的目录,但不如白名单精准:--exclude=vendor,build,var - 若使用
.php-cs-fixer.php配置文件,可在Finder::create()中直接限定路径,比命令行参数更灵活 - 注意:
--path-mode=intersection是关键,否则传入多个路径时可能被忽略
真正容易被忽略的是配置文件的加载逻辑——php-cs-fixer 默认只读取当前工作目录下的 .php-cs-fixer.php,而 Composer 脚本执行时的工作目录就是项目根目录;但如果在子目录下运行 composer run,就可能失效。务必保证配置文件放在项目根目录,且命名准确。











