istanbul-lib-report

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)

Current Tags

3.0.1 ... latest (a year ago)

25 Versions

3.0.1 ... a year ago
3.0.0 ... 5 years ago
3.0.0-alpha.2 ... 5 years ago
3.0.0-alpha.1 ... 5 years ago
3.0.0-alpha.0 ... 5 years ago
2.0.8 ... 6 years ago
2.0.7 ... 6 years ago
2.0.6 ... 6 years ago
2.0.5 ... 6 years ago
2.0.4 ... 6 years ago
2.0.3 ... 6 years ago
2.0.2 ... 6 years ago
1.1.5 ... 6 years ago
2.0.1 ... 6 years ago
2.0.0 ... 6 years ago
1.1.4 ... 7 years ago
1.1.3 ... 7 years ago
1.1.2 ... 7 years ago
1.1.1 ... 7 years ago
1.1.0 ... 8 years ago
1.0.0 ... 8 years ago
1.0.0-alpha.3 ... 9 years ago
1.0.0-alpha.2 ... 9 years ago
1.0.0-alpha.1 ... 9 years ago
1.0.0-alpha.0 ... 9 years ago