grunt-coverage-badger
generate coverage badge from Istanbul coverage report.
Getting Started
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-coverage-badger --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-coverage-badger');
The "coverage_badger" task
Overview
In your project's Gruntfile, add a section named coverage_badger
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
coverage_badger: {
options: {
// Setting the default coverage file generated by istanbul cobertura report.
istanbulReportFile: "./coverage/cobertura-coverage.xml",
// The default location for the destination being the coverage directory from istanbul.
destinationDir: '.',
// The shields host to be used for retrieving the badge. https://github.com/badges/shields
shieldsHost: process.env.SHIELDS_HOST || "https://img.shields.io",
// The name of the badge file to be generated
badgeFileName: "coverage",
// The thresholds to be used to give colors to the badge.
thresholds: {
excellent: 90,
good: 65
}
}
},
});
Options
options.istanbulReportFile
Type: String
Default value: './coverage/cobertura-coverage.xml '
coverage file generated by istanbul cobertura report
options.destinationDir
Type: String
Default value: '.'
location for the destination being the coverage directory from istanbul
options.badgeFileName
Type: String
Default value: 'coverage'
The name of the badge file to be generated
options.thresholds.excellent
Type: String
Default value: '90'
The thresholds to be used to give green color to the badge.
options.thresholds.good
Type: String
Default value: '65'
The thresholds to be used to give yellow color to the badge.
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release History
(Nothing yet)