讲师中心 微信公众号
AI工具推荐 视频效率加速

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

大浩酱_2866

大浩酱_2866

发布时间:2025-12-23 15:42:08

|

745人浏览过

|

来源于php中文网

原创

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

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

直接在 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 规范(也可换为 Squiz、Generic 或自定义规则集)
  • --extensions=php 明确只扫描 PHP 文件
  • --report=full 输出详细报告(也支持 summary、json、checkstyle 等格式)
  • src/ tests/ 是要检查的目录,按需调整

增强实用性的小技巧

让检查更贴近开发流程:

Phy Git Blame Archaeologist
Phy Git Blame Archaeologist

Git 历史考古工具,回答“为什么这段代码存在?”,适用于任意文件、行或可疑代码块。链式调用 git blame → git log --follow → commit 信息...

下载

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

  • 加 --colors 让终端输出带颜色,更易读
  • 加 --ignore="*/vendor/*,*/tests/Bootstrap.php" 排除不需要检查的路径
  • 加 --severity=5 只报告中等及以上严重性问题(默认全部)
  • 写成两个脚本:一个快速检查(cs:check),一个自动修复(cs:fix,需搭配 phpcbf)

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

配合 Git 钩子或 CI 使用

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

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

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

热门AI工具

更多
PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

344

2023.12.25

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

583

2026.04.10

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

347

2026.04.10

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

369

2026.04.10

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

320

2026.04.13

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

503

2026.04.13

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

291

2026.04.14

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

350

2026.04.14

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn