grunt-qunit-missed
v0.3.2
Published
Grunt plugin to assist Instanbul code coverage for missed files.
Downloads
15
Readme
grunt-qunit-missed
This plugin produces a html report of files which have code coverage and those that do not. The html report color-codes the file yellow or red based on if it was hit during an Istanbul coverage pass. The prerequisites for this plugin to function properly are that grunt-qunit-istanbul has been run and html reports have been generated. This plugin will use that information to report files missed or have 0% coverage.
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-qunit-missed --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-qunit-missed');
The "qunit_missed" task
Overview
In your project's Gruntfile, add a section named qunit_missed
to the data object passed into grunt.initConfig()
.
Options
grunt.initConfig({
qunit_missed: {
options: {
// Task-specific options go here.
},
all: {
}
},
})
Options
options.coverageSourceLocation
Type: String
No Default value
Specify where the location of the Istanbul xml or html reports. This can be a clover.xml, cobertura.xml or location of *.js.hmtl files.
options.htmlResultOutputLocation
Type: String
Default value: empty string
Specify where the result html report should be placed. If left empty, the current working directory will be used.
options.teamName
Type: String
Default value: empty string
Specify a name to be displayed at the head of the report.
options.htmlTemplate
Type: String
Default value: node_modules/grunt-qunit-missed/tasks/html/Template_Missing_File_Report.html
Specify a templated file for the output of the results.
options.threshold
Type: number
[optional]
Default value: 0
Specify the percentage threshold to evaluate when running the build. If the actual file coverage percentage is less than this value, the build will fail.
all
all.src
Type: String
No Default value
File list of locations or globs.
Release History
(Nothing yet)