istanbul-lib-report

中文文档
3.0.1发布于 2023/07/25BSD-3-ClauseCommonJS近 30 天下载 3亿

Istanbul 的基础报告库

中文使用文档

istanbul-lib 报告

Greenkeeper badge Build Status

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

示例用途

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 共发布 25 个版本,首次发布于 2015/11/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.1latest2023/07/253 年前
3.0.02019/12/216 年前
3.0.0-alpha.22019/12/086 年前
3.0.0-alpha.12019/10/067 年前
3.0.0-alpha.02019/06/197 年前
2.0.82019/04/257 年前

关于 istanbul-lib-report 的常见问题

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 和提交记录判断。