# @godaddy-wordpress/circleci-coverage-github-reporter 中文文档

规范地址：https://npmcn.com/package/%40godaddy-wordpress/circleci-coverage-github-reporter/

版本：1\.0\.3
npm 元数据更新时间：2022-04-05T18:34:19.631Z
中文译文更新时间：2026-11-16T19:24:17.193Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40godaddy-wordpress/circleci-coverage-github-reporter
原文对照：https://npmcn.com/package/%40godaddy-wordpress/circleci-coverage-github-reporter/?lang=original
项目主页：https://github.com/godaddy-wordpress/circleci-coverage-github-reporter#readme
源码仓库：https://github.com/godaddy-wordpress/circleci-coverage-github-reporter

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

- 包体积（解压后）：199 kB，25 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：6 个
- 首次发布：2020-12-08T18:56:13.658Z
- 最新版本发布：2021-10-19T18:19:03.389Z
- 近 30 天下载量：2826（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

从CircleCI到GitHub的Jest/伊斯坦布尔覆盖统计

## 安装

```sh
npm install @godaddy-wordpress/circleci-coverage-github-reporter
```

也可以使用：`pnpm add @godaddy-wordpress/circleci-coverage-github-reporter`、`yarn add @godaddy-wordpress/circleci-coverage-github-reporter`、`bun add @godaddy-wordpress/circleci-coverage-github-reporter`

## README

# 圆形覆盖- github- 报告器

[![npm version](https://badge.fury.io/js/%40godaddy-wordpress%2Fcircleci-coverage-github-reporter.svg)](https://badge.fury.io/js/%40godaddy-wordpress%2Fcircleci-coverage-github-reporter)

Jest报告/伊斯坦布尔从CircleCI到GitHub的覆盖统计.

基于 [覆盖-github-报告员](https://github.com/vivlabs/coverage-github-reporter)。 。 。 .

## 设置

### GitHub Auth 托肯语

GitHub 认证符号需要发布到 github 上的评论 。 我建议建立一个单独的"机器人"GitHub账户 进入你的仓库.

1.  导航到 [个人访问标志](https://github.com/settings/tokens) 关于 GitHub 的
2.  点击"Generate新令牌"并生成新令牌(与 **还原** 访问,如果您的回购是私人的)
3.  打开 CircleCI 项目设置
4.  构建设置的导航 > 环境变量
5.  添加新变量 `GH_AUTH_TOKEN` 带有新符号

以后的项目:

1.  打开 CircleCI 项目设置
2.  构建设置的导航 > 环境变量
3.  单击“导入变量”
4.  选择您先前添加的工程 `GH_AUTH_TOKEN` 改为
5.  单击旁边的复选框 `GH_AUTH_TOKEN` 导入

### CircleCI 人工活性 API 托肯

要获取私人取回的文物,需要CircleCI API令牌.

1.  打开 CircleCI 项目设置
2.  导航权限 > API 权限
3.  点击“ 创建托肯”

-   从瞄准镜倒下选择“ 已建成的艺术”
-   将符号命名为“ 艺术”( 或随你喜欢的)

4.  构建设置的导航 > 环境变量
5.  添加新变量 `CIRCLE_CI_API_TOKEN` 带有新符号

### 以覆盖度报告运行 Jest

添加到您的 `package.json`数字 :

```bash
npm install --save-dev @godaddy-wordpress/circleci-coverage-github-reporter
```

如果你使用杰斯特,我建议添加一个测试脚本 按照这些思路:

```json
    "scripts": {
        "test-ci": "jest --ci --silent --coverage"
    }
```

这将产生覆盖 `coverage/`

### CircleCI 配置

更新您的 `.circleci/config.yml`数字 :

```yml
general:
  artifacts:
    - "coverage/lcov-report"

jobs:
  build:
    steps:
      # … other steps (npm/yarn install, lint, etc)

      - run:
          name: Test
          command: npm run test-ci

      # Store coverage artifacts so they can be browsed and be diffed by other builds
      - store_artifacts:
          path: coverage
          destination: coverage

      - run:
          name: Post coverage comment to GitHub
          command: npx circleci-coverage-github-reporter
```

### 自定义

这个 `circleci-coverage-github-reporter` CLI 有一些自定义行为的选项:

```
  Options:

    -v, --verbose [true, false]  Defaults to true
    -b, --branch [value]         Base branch to use if not PR (defaults to "master")
    -j, --coverage-json [value]  Relative path to istanbul coverage JSON (defaults to "coverage/coverage-final.json")
    -r, --coverage-root [value]  Relative path to coverage html root (for artifact links) (defaults to "coverage/lcov-report")
    -h, --help                   Output usage information
    -v, --version                Output the version number
```

## 常见问题

### @godaddy-wordpress/circleci-coverage-github-reporter 是什么？

从CircleCI到GitHub的Jest/伊斯坦布尔覆盖统计

### 如何安装 @godaddy-wordpress/circleci-coverage-github-reporter？

在项目目录运行 npm install @godaddy-wordpress/circleci-coverage-github-reporter，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 circleci-coverage-github-reporter，可以用 npx circleci-coverage-github-reporter 直接运行。

### @godaddy-wordpress/circleci-coverage-github-reporter 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/godaddy-wordpress\_\_circleci-coverage-github-reporter 是否存在。

### @godaddy-wordpress/circleci-coverage-github-reporter 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @godaddy-wordpress/circleci-coverage-github-reporter 可以商用吗？

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

### @godaddy-wordpress/circleci-coverage-github-reporter 的下载量有多少？

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

### @godaddy-wordpress/circleci-coverage-github-reporter 还在维护吗？

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

