npm

npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »

danger-plugin-istanbul-coverage

1.6.1 • Public • Published

danger-plugin-istanbul-coverage

Build Status npm version semantic-release

Danger.js plugin for monitoring code coverage on changed files.

Usage

Install:

yarn add danger-plugin-istanbul-coverage --dev

At a glance:

// dangerfile.js
import { schedule } from "danger"
import { istanbulCoverage } from "danger-plugin-istanbul-coverage"
 
schedule(istanbulCoverage()) // Use default configuration
 
schedule(istanbulCoverage({
  // Set a custom success message
  customSuccessMessage: "Congrats, coverage is good",
 
  // Set a custom failure message
  customFailureMessage: "Coverage is a little low, take a look",
 
  // How to sort the entries in the table
  entrySortMethod: "alphabetical" // || "least-coverage" || "most-coverage" || "largest-file-size" ||"smallest-file-size" || "uncovered-lines"
 
  // Add a maximum number of entries to display
  numberOfEntries: 10,
 
  // The location of the istanbul coverage file.
  coveragePath: "./coverage/coverage-summary.json",
  // Alternatively, if you have multiple coverage summaries, you can merge them into one report
  coveragePaths: ["./dir1/coverage-summary.json", "./dir2/coverage-summary.json"]
  // You can also specify the format, instead of letting it be inferred from the file name
  coveragePath: { path: "./coverage/lcov.info", type: "lcov" /* ||  "json-summary" */}
 
  // Which set of files to summarise from the coverage file.
  reportFileSet: "all", // || "modified" || "created" || "createdOrModified"
 
  // What to do when the PR doesn't meet the minimum code coverage threshold
  reportMode: "message", // || "warn" || "fail"
 
  // Minimum coverage threshold percentages. Compared against the cumulative coverage of the reportFileSet.
  threshold: {
    statements: 100,
    branches: 100,
    functions: 100,
    lines: 100,
  }
}))

This plugin requires the 'json-summary' or 'lcov' report modes be enabled with Istanbul. Make sure Danger runs after your unit tests in your CI workflow.

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.

install

npm i danger-plugin-istanbul-coverage

Downloadsweekly downloads

5,834

version

1.6.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability