如何编写一个Composer脚本来检查项目的编码规范?(PHP_CodeSniffer)

admin 百科 15
可在composer.json中配置自定义脚本实现一键编码规范检查:添加"cs:check": "phpcs --standard=PSR12 --extensions=php --report=full src/ tests/"等命令,并推荐配合phpcbf、Git钩子及CI使用。

如何编写一个Composer脚本来检查项目的编码规范?(PHP_CodeSniffer)-第1张图片-佛山资讯网

直接在 composer.json 里配置一个自定义脚本,调用 phpcs 命令即可实现一键检查编码规范。

安装 PHP_CodeSniffer

确保项目已通过 Composer 安装 phpcs(推荐本地安装,避免全局依赖冲突):

  • 运行 composer require --dev squizlabs/php_codesniffer
  • 安装后命令路径为 vendor/bin/phpcs(Linux/macOS)或 vendor\bin\phpcs.bat(Windows)
  • 可选:同时安装常用标准,比如 composer require --dev phpcompatibility/php-compatibility(用于兼容性检查)

配置 composer.json 脚本

composer.json"scripts" 段添加一条检查命令:

"scripts": {
  "cs:check": "phpcs --standard=PSR12 --extensions=php --report=full src/ tests/"
}

登录后复制

  • --standard=PSR12 指定使用 PSR-12 规范(也可换为 SquizGeneric 或自定义规则集)
  • --extensions=php 明确只扫描 PHP 文件
  • --report=full 输出详细报告(也支持 summaryjsoncheckstyle 等格式)
  • src/ tests/ 是要检查的目录,按需调整

增强实用性的小技巧

让检查更贴近开发流程:

立即学习“PHP免费学习笔记(深入)”;

标签: php linux js bootstrap git json composer windows github 编码

发布评论 0条评论)

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