Package Exports
- istanbul-lib-report
- istanbul-lib-report/index.js
- istanbul-lib-report/lib/file-writer
- istanbul-lib-report/lib/file-writer.js
- istanbul-lib-report/lib/path
- istanbul-lib-report/lib/path.js
- istanbul-lib-report/lib/summarizer-factory
- istanbul-lib-report/lib/summarizer-factory.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (istanbul-lib-report) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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)