0

0

如何使用composer scripts来执行代码质量检查

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-09-26 16:21:01

|

550人浏览过

|

来源于php中文网

原创

通过配置composer.json中的scripts字段,可一键执行PHP代码质量检查。例如设置"check-style"、"analyse"、"test"等命令,并组合为"quality"任务,运行composer quality即可依次执行PHPCS、PHPStan和PHPUnit。需先安装对应dev依赖,支持自定义参数与配置文件路径,还可结合Git钩子在提交前自动检测,提升开发效率与代码一致性。

如何使用composer scripts来执行代码质量检查

在 PHP 项目中,使用 Composer scripts 可以简化代码质量检查的流程。你不需要手动运行多个命令,而是通过配置 composer.json 中的 scripts 字段,一键触发静态分析、编码规范检查和单元测试等操作。

配置基本的代码质量检查脚本

打开项目的 composer.json 文件,在 "scripts" 部分添加自定义命令。例如,集成 PHPStan、PHP_CodeSniffer 和 PHPUnit:

"scripts": {
    "check-style": "phpcs --standard=PSR12 src/",
    "analyse": "phpstan analyse src/",
    "test": "phpunit",
    "quality": [
        "@check-style",
        "@analyse",
        "@test"
    ]
}

这样你可以通过运行 composer quality 来依次执行所有质量检查任务。

安装必要的开发依赖

确保相关工具已作为 dev 依赖安装:

  • composer require --dev phpunit/phpunit
  • composer require --dev squizlabs/php_codesniffer
  • composer require --dev phpstan/phpstan

这些工具安装后,Composer 才能正确执行对应的命令。

支持更复杂的脚本逻辑

如果需要指定配置文件或调整参数,可以在 scripts 中写完整命令:

万兴喵影
万兴喵影

国产剪辑神器

下载
"scripts": {
    "check-style": "phpcs -sp --standard=ruleset.xml src/",
    "analyse": "phpstan analyse --configuration=phpstan.neon src/",
    "test-coverage": "phpunit --coverage-html coverage/"
}

也可以使用脚本组合,比如先清理缓存再分析:

"scripts": {
    "clean": "rm -rf cache/",
    "qa": [
        "@clean",
        "@check-style",
        "@analyse"
    ]
}

与 Git 钩子结合使用(可选)

利用 Composer 的事件系统,可以在代码提交前自动运行检查:

"scripts": {
    "pre-commit": "@qa",
    "post-merge": "composer install"
}

然后在 .git/hooks/pre-commit 添加:

#!/bin/sh
exec composer run-script pre-commit

这样每次提交都会自动进行质量检测,防止低质量代码进入仓库。

基本上就这些。通过合理配置 Composer scripts,可以显著提升开发效率和代码一致性,而且团队成员只需记住少量命令即可完成全套检查。不复杂但容易忽略的是保持脚本的可读性和可维护性,避免一行写太长的命令。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

155

2023.12.25

json数据格式
json数据格式

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

313

2023.10.13

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

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

77

2025.09.10

require的用法
require的用法

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

466

2023.11.27

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

744

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

559

2023.07.06

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

54

2026.01.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.5万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 7万人学习

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

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