istanbul-coverage-display
React component which can be added to instrumentation build to display coverage report of testing.
To install
npm install istanbul-coverage-display
It has a peer dependency of React 16. This component should be part of the test build only. In the test build, you should be using babel-plugin-istanbul
to instrument the source code. This component has a peer (indirect) dependency on istanbul-lib-coverage
installed by babel-plugin-istanbul
.
Summary view
import { CoverageSummary } from 'istanbul-coverage-display';
This component adds a button to one of the four corner of the browser window to show coverage report. The position prop accepts four values:
one of bottomLeft, topLeft, bottomRight, topRight. By default, the button is at the bottomLeft.
Detail view
import { CoverageDetail } from 'istanbul-coverage-display';
This shows the detailed coverage report in a tree-table format.
getCoverage API
If you just want the coverage object as a processed JSON object for consumption, use
import { getCoverage } from 'istanbul-coverage-display';
More info
There is a demo project for this package. And there is a blog post with more details about why we need this.
Screenshot of the component display coverage report: