如何让 Composer 在执行 install 后自动检查代码风格?

admin 百科 9
可在 Composer 的 post-install-cmd 钩子中集成 PHP_CodeSniffer 或 PHP-CS-Fixer 实现安装后自动代码风格检查;需作为 dev 依赖安装,配置 scripts 并确保失败时返回非零退出码以阻断流程。

如何让 Composer 在执行 install 后自动检查代码风格?-第1张图片-佛山资讯网

可以在 Composer 的 post-install-cmd 钩子中集成代码风格检查工具(如 PHP_CodeSniffer 或 PHP-CS-Fixer),实现 install 后自动校验。

配置 composer.json 的 scripts 钩子

在项目根目录的 composer.json 中,向 "scripts" 字段添加 "post-install-cmd",调用风格检查命令:

  • 若使用 PHP_CodeSniffer(例如检查 PSR-12):
    "post-install-cmd": "phpcs --standard=PSR12 --extensions=php src/ tests/"
  • 若使用 PHP-CS-Fixer(只检查不修复):
    "post-install-cmd": "php-cs-fixer fix --dry-run --diff --verbose"

确保检查工具已正确安装

风格检查工具需作为开发依赖存在,否则钩子会失败:

  • 运行 composer require --dev squizlabs/php_codesniffer
    composer require --dev friendsofphp/php-cs-fixer
  • 推荐在 require-dev 中声明,并统一配置文件(如 phpcs.xml.php-cs-fixer.php

让检查失败时中断流程(可选但推荐)

默认情况下,即使检查报错,post-install-cmd 仍可能继续执行。可通过以下方式增强可靠性:

标签: composer 代码风格检查 php js json 工具 配置文件

发布评论 0条评论)

还木有评论哦,快来抢沙发吧~