命令行
使用
mcr命令行将使用NODE_V8_COVERAGE=dir来启动一个子进程运行程序,直到正常退出,然后自动从dir目录来读取覆盖率数据,并生成覆盖率报告
- 全局安装
sh
npm i monocart-coverage-reports -g
mcr node ./test/specs/node.test.js -r v8,console-details --lcov- 本地项目安装
sh
npm i monocart-coverage-reports
npx mcr node ./test/specs/node.test.js -r v8,console-details --lcov- CLI 选项
命令使用 Execa 的默认选项执行,不主动开启 shell 模式。请分别传入可执行文件及参数,例如 mcr node "./my app.js",不要把整条命令作为一个带引号的参数传入。MCR 保留参数边界,不展开环境变量或 glob,也不解析管道、重定向、&& 等 shell 语法;组合命令请放入脚本。使用 mcr [options] -- executable ...args 可以避免子命令参数被当作 MCR 参数解析。平台相关的命令执行由 Execa 处理,包括在 Windows 下按需通过 cmd.exe 调用批处理文件并转义参数。
以下选项仅在 CLI 模式(mcr <command>)下可用:
| 选项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
-c, --config | string | — | 自定义配置文件路径 |
--import | string | null | 通过 NODE_OPTIONS 预加载 ESM 模块,如 tsx。 |
--require | string | null | --import 的已弃用别名;使用 ESM 加载,不使用 CommonJS 解析 |
--env | string | null | 从 dotenv 文件加载环境变量(默认 .env)。 |
test(仅配置文件) | string | string[] | null | null | 未指定命令行目标时,原样传给 node --test 的默认测试文件路径或 glob,仅 mcr test 使用;其他命令和 API 忽略。需要 Node.js >= 22.15.0 |
onTestEnd(仅配置文件) | (testResults) => void | Promise<void> | null | 仅 mcr test:测试结果采集完成后、onReady 和覆盖率生成前触发;参见 Hooks |
onStart | (coverageReport) => Promise<void> | null | 子进程启动前触发;参见 Hooks |
onReady | (coverageReport, nodeV8CoverageDir, subprocess) => Promise<void> | null | 子进程退出后、MCR 读取覆盖率前触发;参见 Hooks |
其他选项(如 --name、--reports、--outputDir、--lcov 等)参见 选项配置 表格,它们在 CLI 中的用法相同。
- 使用
--可以隔离子程序参数,以免两种参数混淆
sh
mcr -c mcr.config.js -- sub-cli -c sub-cli.config.js--import <module>/--require <module>: 通过NODE_OPTIONS把一个预加载模块传给子进程。常用于 TypeScript/JSX 运行时(tsx、ts-node等),也可用于加载mcr.config.ts。在所有受支持的 Node.js 版本中均可用。本地路径以当前工作目录为基准,必须明确指定文件扩展名,支持包含空格的路径。包名由原生 ESM 按 MCR 模块位置解析。两个选项都使用import(),并向 Node 传递--import;--require仅为已弃用别名,不提供 CommonJS 加载逻辑。CJS 模块仅通过 Node 内置的 import 互操作支持。
sh
mcr --import tsx node ./test.ts--env [path]: 子进程启动前从 dotenv 文件加载环境变量(默认.env)。使用process.loadEnvFile,在所有受支持的 Node.js 版本中均可用
sh
mcr --env .env.test node ./test.jstest:运行 Node.js 测试并生成覆盖率报告,参见使用mcr test运行测试。merge: 直接合并inputDir中的原始覆盖率数据并生成合并报告,无需启动子进程。
sh
mcr merge -r v8,console-details --inputDir ./coverage-reports/unit/raw,./coverage-reports/e2e/raw --outputDir ./coverage-reports/merged参见 合并覆盖率报告。
- 参见例子