istanbul-lib-report
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/istanbul-lib-report package

3.0.1 • Public • Published

istanbul-lib-report

Greenkeeper badge Build Status

Core reporting utilities for istanbul.

Example usage

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)

Readme

Keywords

Package Sidebar

Install

npm i istanbul-lib-report

Weekly Downloads

26,242,361

Version

3.0.1

License

BSD-3-Clause

Unpacked Size

37.6 kB

Total Files

13

Last publish

Collaborators

  • gotwarlost
  • bcoe
  • coreyfarrell
  • oss-bot