# @circleci/jest-circleci-coverage 中文文档

规范地址：https://npmcn.com/package/%40circleci/jest-circleci-coverage/

版本：0\.4\.1153
npm 元数据更新时间：2026-11-04T08:59:47.193Z
中文译文更新时间：2026-11-09T16:36:10.581Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40circleci/jest-circleci-coverage
原文对照：https://npmcn.com/package/%40circleci/jest-circleci-coverage/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：25.6 kB，31 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- peer 依赖：jest \>=28\.0\.0 \<31\.0\.0，ts-node ^10\.9\.2，@jest/types \>=28\.0\.0 \<31\.0\.0，@jest/reporters \>=28\.0\.0 \<31\.0\.0，@jest/environment \>=28\.0\.0 \<31\.0\.0，jest-environment-node \>=28\.0\.0 \<31\.0\.0，jest-environment-jsdom \>=28\.0\.0 \<31\.0\.0
- 首次发布：2026-07-31T14:22:43.392Z
- 最新版本发布：2026-11-04T08:59:46.877Z
- 近 30 天下载量：49164（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 46 个）

## 中文简介

一个为 CircleCI 智能测试生成覆盖数据的Jest插件.

## 安装

```sh
npm install @circleci/jest-circleci-coverage
```

也可以使用：`pnpm add @circleci/jest-circleci-coverage`、`yarn add @circleci/jest-circleci-coverage`、`bun add @circleci/jest-circleci-coverage`

## README

# 圈状覆盖

一个为 CircleCI 智能测试生成覆盖数据的Jest插件.

## 使用量

此插件使用 v8 JS 引擎配置器 API 来收集覆盖.

安装插件 .

```shell
pnpm add -D @circleci/jest-circleci-coverage
```

Jest测试环境是同伴的依赖——你需要自己安装, 匹配您计划使用的环境。 该插件支持Jest 28,29和30.

关于以节点为基础的测试:

```shell
pnpm add -D jest jest-environment-node
```

对于类似浏览器的测试(如React Testing Library),则安装了JSDOM环境:

```shell
pnpm add -D jest jest-environment-jsdom
```

定出一个特定的主机(例如,在有较新版本的情况下仍停留在Jest 29上), 通过一个明确的版本范围 :

```shell
pnpm add -D jest@^29 jest-environment-node@^29
```

将自定义的运行器和记录器添加到您的 `jest.config.ts`数字 :

```ts
import {createDefaultPreset} from 'ts-jest';
import type {Config} from 'jest';

const tsJestTransformCfg = createDefaultPreset().transform;

const config: Config = {
  testEnvironment: '@circleci/jest-circleci-coverage/environment-node',
  reporters: ['default', '@circleci/jest-circleci-coverage/reporter'],
  transform: {
    ...tsJestTransformCfg,
  },
};

export default config;
```

对于类似浏览器的测试(如React Testing Library),使用基于JSDOM的环境:

```ts
import {createDefaultPreset} from 'ts-jest';
import type {Config} from 'jest';

const tsJestTransformCfg = createDefaultPreset().transform;

const config: Config = {
  testEnvironment: '@circleci/jest-circleci-coverage/environment-jsdom',
  reporters: ['default', '@circleci/jest-circleci-coverage/reporter'],
  transform: {
    ...tsJestTransformCfg,
  },
};

export default config;
```

设定 `CIRCLECI_COVERAGE` 运行测试时的环境变量,以允许测试覆盖.

```shell
CIRCLECI_COVERAGE=coverage.json jest
```

## 发展

安装并使用当前节点版本 .

```shell
NODE_VER=$(cat ./.nvmrc)
nvm install $NODE_VER
nvm use $NODE_VER
```

用 pnpm 安装依赖性 .

```shell
pnpm install
```

构建插件 .

```shell
pnpm build
```

运行测试.

```shell
pnpm test
```

## 常见问题

### @circleci/jest-circleci-coverage 是什么？

一个为 CircleCI 智能测试生成覆盖数据的Jest插件\.

### 如何安装 @circleci/jest-circleci-coverage？

在项目目录运行 npm install @circleci/jest-circleci-coverage，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：jest（\>=28\.0\.0 \<31\.0\.0）、ts-node（^10\.9\.2）、@jest/types（\>=28\.0\.0 \<31\.0\.0）、@jest/reporters（\>=28\.0\.0 \<31\.0\.0）、@jest/environment（\>=28\.0\.0 \<31\.0\.0）、jest-environment-node（\>=28\.0\.0 \<31\.0\.0）、jest-environment-jsdom（\>=28\.0\.0 \<31\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @circleci/jest-circleci-coverage 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @circleci/jest-circleci-coverage 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @circleci/jest-circleci-coverage 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @circleci/jest-circleci-coverage 可以商用吗？

@circleci/jest-circleci-coverage 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @circleci/jest-circleci-coverage 的下载量有多少？

根据 npm 官方下载统计，@circleci/jest-circleci-coverage 在 2026/10/10 – 2026/11/08 这 30 天内被下载 49,164 次，日均约 1,639 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @circleci/jest-circleci-coverage 还在维护吗？

最新版本 0\.4\.1153 发布于 2026/11/04（5 天前）；至今共发布 46 个版本，其中过去 12 个月发布了 46 个；首次发布于 2026/07/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。