如何编写一个Composer脚本来检查项目的编码规范？（PHP

如何编写一个Composer脚本来检查项目的编码规范？（PHP_CodeSniffer）

冰火之心

发布： 2025-12-23 15:42:08

原创

725人浏览过

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

如何编写一个composer脚本来检查项目的编码规范？（php_codesniffer）

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

确保项目已通过 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 的 "scripts" 段添加一条检查命令：

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

登录后复制

让检查更贴近开发流程：

lavender.ai

销售类电子邮件写作教练

112

例如修复脚本："cs:fix": "phpcbf --standard=PSR12 --extensions=php src/ tests/"

检查脚本本身不自动阻止提交，但可以集成到工作流中：

CI 中（如 GitHub Actions）直接运行 composer cs:check，失败则中断构建
本地可用 composer install 后自动注册钩子，或配合 composer/composer-plugin 类工具
简单方案：在 pre-commit 钩子里执行 composer cs:check || exit 1（需额外安装 husky 或 simple-git-hooks）

基本上就这些 —— 不复杂但容易忽略的是路径和标准的一致性，建议把 phpcs.xml 配置文件也放进项目根目录，比命令行参数更易维护。

以上就是如何编写一个Composer脚本来检查项目的编码规范？（PHP_CodeSniffer）的详细内容，更多请关注php中文网其它相关文章！