# danger-plugin-coverage
> A Danger plugin to report code coverage.
Latest version **1.6.2** (published 2020-11-24) · MIT license · 0 weekly downloads
## Install
```sh
npm install danger-plugin-coverage
pnpm add danger-plugin-coverage
yarn add danger-plugin-coverage
bun add danger-plugin-coverage
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.6.2 |
| Published | 2020-11-24 |
| First published | 2020-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 56.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alex Mendes |
| Maintainers | alexmendes |
| Keywords | danger, danger-plugin, coverage, clover |
## Links
- npm: https://www.npmjs.com/package/danger-plugin-coverage
- Repository: https://github.com/alexandermendes/danger-plugin-coverage
- Homepage: https://github.com/alexandermendes/danger-plugin-coverage#readme
- Issues: https://github.com/alexandermendes/danger-plugin-coverage/issues
- npm.io page: https://npm.io/package/danger-plugin-coverage
## Dependencies (2)
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.23
- [fast-glob](https://npm.io/package/fast-glob.md) ^3.2.4
## Recent versions
- 1.6.2 (latest) — 2020-11-24
- 1.6.1 — 2020-11-19
- 1.6.0 — 2020-11-04
- 1.5.0 — 2020-11-04
- 1.4.1 — 2020-11-03
- 1.4.0 — 2020-11-03
- 1.3.3 — 2020-11-02
- 1.3.2 — 2020-11-02
- 1.3.1 — 2020-11-02
- 1.3.0 — 2020-11-01
- 1.2.0 — 2020-11-01
- 1.1.0 — 2020-10-31
- 1.0.0 — 2020-10-31
## README
# danger-plugin-coverage
[](https://badge.fury.io/js/danger-plugin-coverage)
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/alexandermendes/danger-plugin-coverage/actions)
> A Danger plugin to report code coverage.
This plugin detects and parses coverage reports, posting the results as a
Markdown table back to the pull request.
It uses the `clover.xml` format, which is output by [Istanbul](https://istanbul.js.org/),
a coverage reporter integrated with JavaScript testing tools such as
[Jest](https://jestjs.io/) and [Karma](https://karma-runner.github.io/).
This format can also be output by testing libraries for other languages, such as
[PHPUnit](https://phpunit.de/). So, while this is primarily intended as a tool
to run against JavaScript packages it would technically work as a coverage
reporter for other languages too.
View an example report
## Coverage Report
> Test coverage is looking a little low for the files created or modified in this PR, perhaps we need to improve this.
```
Coverage threshold for branches (80%) not met: 49.08%
Coverage threshold for functions (80%) not met: 74.46%
```
|Impacted Files|% Stmts|% Branch|% Funcs|% Line|Uncovered Lines||
|---|:-:|:-:|:-:|:-:|:-:|:-:|
|[src/module-one.js]()|100|100|100|100||:white_check_mark:|
|[src/module-two.js]()|95.24|33.33|66.67|80|[1](), [42](), [1337]()...|:x:|
|[src/module-three.js]()|82.33|10.25|44.55|45.55|[12](), [15](), [32]()...|:x:|
|[src/module-four.js]()|100|0|10|32.5|[54](), [65](), [94]()...|:x:|
|[src/module-five.js]()|100|100|100|100||:white_check_mark:|
and 2 more...
|Impacted Files|% Stmts|% Branch|% Funcs|% Line|Uncovered Lines||
|---|:-:|:-:|:-:|:-:|:-:|:-:|
|[src/module-six.js]()|100|100|100|100||:white_check_mark:|
|[src/module-seven.js]()|100|100|100|100||:white_check_mark:|
## Usage
Install:
```sh
yarn add danger-plugin-coverage --dev
```
At a glance:
```js
// dangerfile.js
import coverage from 'danger-plugin-coverage';
schedule(coverage());
```
Note that the coverage report output by your test runner must exist before Danger
is run. By default we will look for the report at `coverage/clover.xml`, which
is the default output location for Jest.
## Settings
The function accepts a settings object with the following properties:
| name | description |
|----------------------|----------------------------------------------------------------------------------------------|
| `successMessage` | A custom message to show when coverage is above the threshold. |
| `failureMessage` | A custom message to show when coverage is below the threshold. |
| `cloverReportPath` | Override automatic coverage report detection to provide the relative path to a report. |
| `maxRows` | The number of rows to show (additional rows will be collapsed within a `` element). |
| `maxChars` | The maximum number of characters to allow in a file name cell. |
| `maxUncovered` | The maximum number of uncovered lines to show. |
| `wrapFilenames` | Wrap long file names to help the table fit in a PR comment. |
| `threshold` | The thresholds at which to show the failure messaging. |
| `warnOnNoReport` | Show a warning if no coverage report was detected. |
**Example (defaults shown):**
```js
import coverage from 'danger-plugin-coverage';
schedule(coverage({
successMessage: ':+1: Test coverage is looking good.',
failureMessage: 'Test coverage is looking a little low for the files created '
+ 'or modified in this PR, perhaps we need to improve this.',
cloverReportPath: './coverage/clover.xml',
maxRows: 3,
maxChars: 100,
maxUncovered: 10,
wrapFilenames: true,
warnOnNoReport: true,
showAllFiles: false,
threshold: {
statements: 80,
branches: 80,
functions: 80,
lines: 80,
},
}));
```
---
_Source: https://npm.io/package/danger-plugin-coverage · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._