0

0

如何为Composer项目集成PHPStan或Psalm进行静态分析? (scripts钩子)

冰火之心

冰火之心

发布时间:2026-01-30 15:11:02

|

235人浏览过

|

来源于php中文网

原创

PHPStan用composer require --dev phpstan/phpstan安装并自动生成phpstan.neon;Psalm需先composer require --dev vimeo/psalm再运行vendor/bin/psalm --init生成psalm.xml,二者均不建议全局安装且需在配置中明确paths以确保扫描正确目录。

如何为composer项目集成phpstan或psalm进行静态分析? (scripts钩子)

PHPStan 和 Psalm 的安装方式差异

PHPStan 推荐用 composer require --dev phpstan/phpstan 安装,它默认不带配置文件,首次运行会提示生成 phpstan.neon;Psalm 则必须先初始化:composer require --dev vimeo/psalm,再执行 vendor/bin/psalm --init 生成 psalm.xml。两者都不建议全局安装——路径不可控,且 composer scripts 依赖本地 vendor/bin/ 下的可执行文件。

composer.json 中定义 scripts 钩子

直接写进 "scripts" 段,避免每次手动敲长命令。注意:Psalm 默认扫描 src/tests/,PHPStan 默认只扫 src/,若项目结构不同(比如用 lib/app/),必须在配置文件里改 paths,否则钩子跑出来全是“未扫描到文件”。

{
    "scripts": {
        "analyse": [
            "@phpstan",
            "@psalm"
        ],
        "phpstan": "phpstan analyse --no-progress --level=5",
        "psalm": "psalm --no-severity-highlighting --show-info=false"
    }
}

关键点:

  • --level=5 是 PHPStan 的推荐起始等级,太低(如 0)几乎不报错,太高(如 8)可能因类型推导失败误报
  • Psalm 的 --show-info=false 关闭冗余提示,否则 CI 日志刷屏
  • 两个命令都加了 --no-progress / --no-severity-highlighting,避免 ANSI 控制符干扰 CI 环境输出

CI 流水线中调用与退出码处理

GitHub Actions、GitLab CI 等环境里,直接运行 composer analyse 即可。但要注意:PHPStan 和 Psalm 在发现错误时返回非零退出码(1),这是正确行为——CI 会因此中断流程。如果想让 CI 继续运行并汇总结果(比如同时跑 PHPStan + Psalm + PHPUnit),得用 && 连接,或用 || true 强制继续(不推荐,掩盖问题)。

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

一糖导航
一糖导航

一糖导航丨实用的上网导航资源网址导航

下载

常见陷阱:

  • 没加 --no-interaction,Psalm 初始化后残留交互提示,导致 CI 卡住
  • PHPStan 配置里写了 includes: 引入了不存在的 neon 文件,直接报错退出,而不是分析失败
  • Psalm 的 psalm.xmlerrorLevel="1" 被误设为 "0",等于关闭所有检查

如何让静态分析真正落地而不被绕过

最常被忽略的是「分析范围」和「类型注解覆盖」。PHPStan 对 PHPDoc 类型(如 @param string[] $items)强依赖;Psalm 更进一步,能推导泛型和数组键类型,但前提是代码里有足够注解或 PHP 8.0+ 原生类型。没有注解的函数参数、返回值、属性,两者都会跳过深度检查。

实操建议:

  • 先用 phpstan analyse --generate-baseline 生成基线,把当前存量问题记下来,后续只报新增问题
  • Psalm 可以用 psalm --update-baseline 更新基线,但别在 CI 里自动执行,容易把新 bug 当旧债
  • composer.jsonscripts 里加 "analyse:strict": "phpstan analyse --level=max" 作为阶段性目标,而非默认命令

类型系统不是开关,是渐进过程。配置文件里少一行 paths,或多一个 ignoreErrors,就可能让关键路径彻底失效。

热门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数据格式相关文章,帮助大家解决问题。

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的详细内容,可以访问本专题下面的文章。

311

2023.10.13

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

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

77

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

463

2023.08.02

require的用法
require的用法

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

466

2023.11.27

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

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

1903

2024.04.01

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

9

2026.01.30

热门下载

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

精品课程

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

共137课时 | 10.2万人学习

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号