istanbul-lib-report

Core reporting utilities for istanbul.

Example usage

1const libReport = require('istanbul-lib-report');
2const reports = require('istanbul-reports');
3
4// coverageMap, for instance, obtained from istanbul-lib-coverage
5const coverageMap;
6
7const configWatermarks = {
8  statements: [50, 80],
9  functions: [50, 80],
10  branches: [50, 80],
11  lines: [50, 80]
12};
13
14// create a context for report generation
15const context = libReport.createContext({
16  dir: 'report/output/dir',
17  // The summarizer to default to (may be overridden by some reports)
18  // values can be nested/flat/pkg. Defaults to 'pkg'
19  defaultSummarizer: 'nested',
20  watermarks: configWatermarks,
21  coverageMap,
22})
23
24// create an instance of the relevant report class, passing the
25// report name e.g. json/html/html-spa/text
26const report = reports.create('json', {
27  skipEmpty: configSkipEmpty,
28  skipFull: configSkipFull
29})
30
31// call execute to synchronously create and write the report to disk
32report.execute(context)