寻找适配Jenkins等无彩色环境的Vitest纯文本Reporter方案
Vitest 适配无彩色场景的纯文本报告器落地方案
现有可用的成熟实现
目前有两类稳定可用的纯文本报告器,均能解决Jenkins、Sublime Text等环境下默认报告乱码、难读的问题:
- 官方内置的
basic报告器:随Vitest原生自带,无需额外安装依赖,兼容性最稳定,输出为逐行静态文本,无动态刷新内容。 - 第三方纯文本报告器
vitest-reporter-plain-text:专门面向CI场景优化,支持自定义输出粒度,日志冗余度更低。
具体配置方案
方案1:零依赖官方方案(优先推荐)
不需要安装任何第三方包,直接修改Vitest配置即可生效,适配所有不支持彩色、不支持终端动态控制字符的场景。
配置文件vitest.config.ts示例:
import { defineConfig } from 'vitest/config' export default defineConfig({ test: { // 指定使用静态纯文本报告器 reporters: 'basic', // 全局关闭ANSI彩色转义字符输出 color: false, // 关闭监听模式,避免输出动态刷新的进度内容 watch: false } })
如果是临时在命令行调用,直接追加参数即可:npx vitest run --reporter=basic --no-color
该方案输出的所有内容都是静态逐行打印的,没有光标移动、内容覆写的控制字符,也没有彩色转义码,在Jenkins构建日志、Sublime Text构建面板、老旧终端环境下都可以正常阅读,不会出现乱码、串行、内容被覆盖的问题。
方案2:自定义粒度的第三方报告器方案
如果官方basic报告的输出粒度不符合需求,可以使用专门优化的第三方纯文本报告器。
首先安装依赖:npm install -D vitest-reporter-plain-text
之后在配置文件中指定报告器即可:
import { defineConfig } from 'vitest/config' export default defineConfig({ test: { reporters: 'vitest-reporter-plain-text', color: false } })
该报告器支持配置是否展示成功用例详情、失败堆栈截断长度等参数,可以避免CI日志过长。
Jenkins场景额外适配提示
- 禁止使用默认的
default报告器:该报告器默认依赖ANSI控制字符实现进度条动态刷新、彩色高亮,在无相关支持的环境中会显示为[32m✓[39m类乱码,还会因为动态覆写导致日志内容缺失、串行。 - 如果需要在Jenkins中展示测试趋势统计,可以同时追加junit报告器输出结构化结果,和纯文本日志输出互不冲突,配置示例:
reporters: ['basic', 'junit'],输出的XML文件可直接被Jenkins测试结果插件解析。 - 如果Jenkins已安装ANSI颜色支持插件,也可以不关闭
color配置,只要将报告器切换为basic即可解决动态刷新导致的阅读问题,但无彩色配置的兼容性最高,不依赖任何Jenkins插件能力。
内容的提问来源于stack exchange,提问作者Tom Talbott
相关产品推荐
相关产品推荐

