Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

danger-plugin-coverage

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

danger-plugin-coverage

A Danger plugin to report code coverage.

  • 1.3.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2K
decreased by-35.08%
Maintainers
1
Weekly downloads
 
Created
Source

danger-plugin-coverage

npm version semantic-release .github/workflows/deploy.yml

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, a coverage reporter integrated with JavaScript testing tools such as Jest and Karma.

This format can also be output by testing libraries for other languages, such as PHPUnit. 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
src/module-one.js100100100100:white_check_mark:
src/module-two.js95.2433.3366.67100:x:
src/module-three.js82.3310.2544.55100:x:
src/module-four.js100010100:x:
src/module-five.js100100100100:white_check_mark:
and 2 more...
Impacted Files% Stmts% Branch% Funcs% Lines
src/module-six.js100100100100:white_check_mark:
src/module-seven.js100100100100:white_check_mark:

Usage

Install:

yarn add danger-plugin-coverage --dev

At a glance:

// 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:

namedescription
successMessageA custom message to show when coverage is above the threshold.
failureMessageA custom message to show when coverage is bellow the threshold.
cloverReportPathOverride automatic coverage report detection to provide the relative path to a report.
maxRowsThe number of rows to show (additional rows will be collapsed within a <details> element).
thresholdThe thresholds at which to show the failure messaging.

Example:

import coverage from 'danger-plugin-coverage';

schedule(coverage({
  successMessage: ':+1: Test coverage is looking good.',
  failureMessage: ':-1: Test coverage is not looking so good.',
  cloverReportPath: './coverage/clover.xml',
  maxRows: 5,
  threshold: {
    statements: 80,
    branches: 80,
    functions: 80,
    lines: 80,
  },
}));

Keywords

FAQs

Package last updated on 02 Nov 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc