0

0

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

冰火之心

冰火之心

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

|

725人浏览过

|

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

增强实用性的小技巧

让检查更贴近开发流程:

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

PictoGraphic
PictoGraphic

AI驱动的矢量插图库和插图生成平台

下载
  • --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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

152

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

418

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1900

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2091

2024.08.01

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

158

2026.01.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 9.9万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号