grunt-dotnet-codecoverage
Grunt plugin to generate code coverage report using opencover and reportgenerator
Getting Started
This plugin requires Grunt ~0.4.2
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-dotnet-codecoverage --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "codecoverage" task
Overview
In your project's Gruntfile, add a section named codecoverage
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.opencoverExe
Type: String
Default value: ``
A string value pointing to the open cover executable.
options.reportGeneratorExe
Type: String
Default value: ``
A string value pointing to the report generator executable.
options.target
Type: String
Default value: ``
A string value pointing to the target being executed by opencover executable. Files provided in the source will be used as the arguments for this target.
options.output
Type: String
Default value: reports/codecoverage
A string value pointing to the folder where the reports should be generated.
options.registerUser
Type: Boolean
Default value: undefined
A boolean value indictating if the -register:user
switch should be added to the generated command.
options.reportTypes
Type: Array
Default value: undefined
An Array value indicating which report types should be generated by reportgenerator.
Usage Examples
The toolsPath in this example points to the opencover nuget package tools folder. The report will be stored in the reports folder relative to your grunt file. The specs target will execute all dll's ending with Spec.dll
located in all bin/Debug
folders within the test/src
folder.
grunt;
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)