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

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

版本：0\.3\.1184
npm 元数据更新时间：2026-11-06T12:56:59.914Z
中文译文更新时间：2026-11-09T17:20:21.469Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：16.3 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- peer 依赖：cypress \>=15\.0\.0
- 首次发布：2026-07-31T14:20:31.739Z
- 最新版本发布：2026-11-06T12:56:59.737Z
- 近 30 天下载量：2140（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：40（近 12 个月 40 个）

## 中文简介

生成 CircleCI 智能测试的覆盖数据

## 安装

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

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

## README

# 囊压-环状覆盖

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

## 使用量

此插件使用从浏览器收集的伊斯坦布尔代码覆盖来映射 要测试规格的源文件 .

安装插件 .

```bash
pnpm add -D @circleci/cypress-circleci-coverage
```

将插件添加到您的 Cypress 配置 :

将您的代码与伊斯坦布尔(例如通过) `babel-plugin-istanbul` 在一个 webpack 预处理器) `window.__coverage__` 可在 测试执行时浏览器 .

```typescript
// cypress.config.ts
import {defineConfig} from 'cypress';
import cypressCircleCICoverage from '@circleci/cypress-circleci-coverage/plugin';

export default defineConfig({
  e2e: {
    supportFile: './cypress/support/e2e.ts',
    setupNodeEvents(on, config) {
      const webpackOptions = {
        module: {
          rules: [
            {
              test: /\.ts$/,
              exclude: /node_modules/,
              use: {
                // instrument files with the istanbul plugin.
                loader: 'babel-loader',
                options: {
                  presets: ['@babel/preset-typescript'],
                  plugins: [['istanbul']],
                },
              },
            },
          ],
        },
      };

      on('file:preprocessor', webpackPreprocessor({webpackOptions}));

      return cypressCircleCICoverage(on, config);
    },
  },
});
```

导入您的 Cypress 支持文件中的支持文件 :

```typescript
// cypress/support/e2e.ts
import '@circleci/cypress-circleci-coverage/support';
```

设定 `CIRCLECI_COVERAGE` 运行测试到时的环境变量 启用覆盖收集.

```bash
CIRCLECI_COVERAGE=coverage.json cypress run
```

## 发展

用 pnpm 安装依赖性 .

```bash
pnpm install
```

安装cypress.

```bash
pnpm cypress install
```

构建插件 .

```bash
pnpm build
```

运行测试.

```bash
pnpm test
```

## 常见问题

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

生成 CircleCI 智能测试的覆盖数据

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

在项目目录运行 npm install @circleci/cypress-circleci-coverage，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：cypress（\>=15\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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

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

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