# istanbul-lib-report 中文文档

规范地址：https://npmcn.com/package/istanbul-lib-report/

版本：3\.0\.1
npm 元数据更新时间：2023-07-25T14:31:38.537Z
中文译文更新时间：2026-11-05T15:44:06.605Z
软件包许可：BSD-3-Clause

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

原始 npm 页面：https://www.npmjs.com/package/istanbul-lib-report
原文对照：https://npmcn.com/package/istanbul-lib-report/?lang=original
项目主页：https://istanbul.js.org/
源码仓库：https://github.com/istanbuljs/istanbuljs

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

- 包体积（解压后）：37.6 kB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=10
- 运行依赖：3 个
- 首次发布：2015-11-22T06:51:48.997Z
- 最新版本发布：2023-07-25T14:31:38.404Z
- 近 30 天下载量：298855263（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 0 个）

## 中文简介

Istanbul 的基础报告库

## 安装

```sh
npm install istanbul-lib-report
```

也可以使用：`pnpm add istanbul-lib-report`、`yarn add istanbul-lib-report`、`bun add istanbul-lib-report`

## README

# istanbul-lib 报告

[![Greenkeeper badge](https://badges.greenkeeper.io/istanbuljs/istanbul-lib-report.svg)](https://greenkeeper.io/) [![Build Status](https://travis-ci.org/istanbuljs/istanbul-lib-report.svg?branch=master)](https://travis-ci.org/istanbuljs/istanbul-lib-report)

伊斯坦堡核心报告公用事业.

## 示例用途

```js
const libReport = require('istanbul-lib-report');
const reports = require('istanbul-reports');

// coverageMap, for instance, obtained from istanbul-lib-coverage
const coverageMap;

const configWatermarks = {
  statements: [50, 80],
  functions: [50, 80],
  branches: [50, 80],
  lines: [50, 80]
};

// create a context for report generation
const context = libReport.createContext({
  dir: 'report/output/dir',
  // The summarizer to default to (may be overridden by some reports)
  // values can be nested/flat/pkg. Defaults to 'pkg'
  defaultSummarizer: 'nested',
  watermarks: configWatermarks,
  coverageMap,
})

// create an instance of the relevant report class, passing the
// report name e.g. json/html/html-spa/text
const report = reports.create('json', {
  skipEmpty: configSkipEmpty,
  skipFull: configSkipFull
})

// call execute to synchronously create and write the report to disk
report.execute(context)
```

## 常见问题

### istanbul-lib-report 是什么？

Istanbul 的基础报告库

### 如何安装 istanbul-lib-report？

在项目目录运行 npm install istanbul-lib-report，或使用 pnpm add / yarn add / bun add。

### istanbul-lib-report 支持 TypeScript 吗？

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

### istanbul-lib-report 支持 ESM 还是 CommonJS？

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

### istanbul-lib-report 需要什么版本的 Node\.js？

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

### istanbul-lib-report 可以商用吗？

istanbul-lib-report 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### istanbul-lib-report 的下载量有多少？

根据 npm 官方下载统计，istanbul-lib-report 在 2026/10/05 – 2026/11/03 这 30 天内被下载 298,855,263 次，日均约 9,961,842 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### istanbul-lib-report 还在维护吗？

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