0

0

如何利用 composer scripts 自动运行代码质量检查工具?

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-11-22 18:43:02

|

536人浏览过

|

来源于php中文网

原创

在PHP项目中通过Composer配置scripts可自动化代码质量检查。首先安装phpcs、phpstan、psalm、php-cs-fixer等开发依赖,随后在composer.json的scripts字段定义post-install-cmd、post-update-cmd及自定义命令如php-cs-fixer和phpstan,实现安装或更新后自动执行检测;通过composer run check-quality可手动触发组合检查,结合CI/CD与Git hooks(如pre-commit)将检查嵌入开发流程,提升规范遵循度,减少人为疏漏。

如何利用 composer scripts 自动运行代码质量检查工具?

在 PHP 项目中,利用 Composer 的 scripts 功能可以在安装或更新依赖时自动运行代码质量检查工具,帮助团队保持代码规范和质量。通过简单配置 composer.json 文件中的 scripts 字段,就能实现自动化检测。

配置常用代码质量工具

首先确保项目中已安装所需的代码检查工具,推荐使用以下常用工具:

  • phpcs:PHP CodeSniffer,检查代码是否符合编码标准
  • phpstan:静态分析工具,发现潜在错误
  • psalm:另一款强大的静态分析器
  • php-cs-fixer:自动修复不符合规范的代码

通过 Composer 安装这些工具(建议作为开发依赖):

composer require --dev squizlabs/php_codesniffer phpstan/phpstan friendsofphp/php-cs-fixer

定义 Composer Scripts

composer.json 中添加 scripts 配置,定义需要自动执行的命令:

"scripts": { "post-install-cmd": "echo 'Running code quality checks after install...'", "post-update-cmd": [ "@php-cs-fixer", "@phpstan" ], "php-cs-fixer": "php-cs-fixer fix --dry-run --verbose", "phpstan": "phpstan analyse src --level=5", "check-quality": [ "@php-cs-fixer", "@phpstan" ] }

说明:

  • post-install-cmdpost-update-cmd:在 composer install 或 update 后自动运行
  • 自定义脚本如 php-cs-fixerphpstan 可被复用
  • check-quality 是一个组合命令,可手动触发全部检查

运行与调试

执行以下命令查看效果:

SEEK.ai
SEEK.ai

AI驱动的智能数据解决方案,询问您的任何数据并立即获得答案

下载
  • composer installcomposer update:触发 post-xxx 命令
  • composer run check-quality:手动运行所有检查
  • composer run:列出所有可用脚本

若想临时跳过检查,可加参数:composer install --no-scripts

集成到开发流程

将这些脚本整合进日常开发习惯中:

  • 提交代码前运行 composer run check-quality
  • CI/CD 流程中加入 composer update,自动触发检查
  • 配合 Git hooks(如 pre-commit)调用 Composer 脚本,提前拦截不合规代码

例如,在 .git/hooks/pre-commit 中加入:

#!/bin/sh\nexec composer run php-cs-fixer

基本上就这些。合理使用 Composer scripts 能让代码质量检查变得透明且自动化,减少人为遗漏。关键是把检查变成流程的一部分,而不是额外负担。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

154

2023.12.25

json数据格式
json数据格式

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

419

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

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

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

724

2023.07.05

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

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

556

2023.07.06

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

热门下载

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

精品课程

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

共137课时 | 10.1万人学习

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号