README.md

ReportGenerator

Powerful code coverage visualization

ReportGenerator converts coverage reports generated by OpenCover, dotCover, Visual Studio, NCover, Cobertura, JaCoCo, Clover, gcov or lcov into human readable reports in various formats.

The reports do not only show the coverage quota, but also include the source code and visualize which lines have been covered.

ReportGenerator supports merging several reports into one.

License

• ReportGenerator is licensed under the Apache License, Version 2.0
• You can support the project by becoming a sponsor.
  I encourage you to do so, especially if you are using ReportGenerator for commercial projects.

Getting started

ReportGenerator is a commandline tool which works with full .NET Framework and .NET Core.
Use the online configuration tool to get started quickly.

Install the package matching your platform and needs

Package	Platforms	Installation/Usage
ReportGenerator	.NET Core 2.x, 3.x .NET Framework 4.7	Use this package if your project is based on .NET Framework or .NET Core and you want to use ReportGenerator via the command line or a build script. Usage dotnet $(UserProfile).nuget\packages\reportgenerator\x.y.z\tools\netcoreapp3.0\ReportGenerator.dll [options] $(UserProfile).nuget\packages\reportgenerator\x.y.z\tools\netcoreapp3.0\ReportGenerator.exe [options] $(UserProfile)\.nuget\packages\reportgenerator\x.y.z\tools\net47\ReportGenerator.exe [options]
dotnet-reportgenerator-globaltool	.NET Core 2.1, 3.x	Use this package if your project is based on .NET Core and you want to use ReportGenerator as a (global) 'DotnetTool'. Installation dotnet tool install -g dotnet-reportgenerator-globaltool dotnet tool install dotnet-reportgenerator-globaltool --tool-path tools dotnet new tool-manifest dotnet tool install dotnet-reportgenerator-globaltool Usage reportgenerator [options] tools\reportgenerator.exe [options] dotnet reportgenerator [options]
dotnet-reportgenerator-cli	.NET Core 2.0	Use this package if your project is based on .NET Core 2.x and you want to use ReportGenerator as a 'DotnetCliTool'. Warning This package is intended for .NET Core 2.x. It will not work with .NET Core 3.x. Consider the dotnet-reportgenerator-globaltool for .NET Core 3.x. Installation Add <DotNetCliToolReference Include="dotnet-reportgenerator-cli" Version="x.y.z" /> to your project file. Usage dotnet reportgenerator [options]
ReportGenerator.Core	.NET Standard 2.0	Use this package if you want to write a custom plugin for ReportGenerator or if you want to call/execute ReportGenerator within your code base. Plugin development Custom reports Custom history storage
Azure DevOps extension	.NET Core >=2.1	Add the Azure DevOps extension to your build pipeline. Learn more
GitHub Actions	.NET Core >=2.1	Add the GitHub Action to your build pipeline. Learn more

Usage / Command line parameters

Parameters:
    ["]-reports:<report>[;<report>][;<report>]["]
    ["]-targetdir:<target directory>["]
    [["]-reporttypes:<Html|HtmlSummary|...>[;<Html|HtmlSummary|...>]["]]
    [["]-sourcedirs:<directory>[;<directory>][;<directory>]["]]
    [["]-historydir:<history directory>["]]
    [["]-plugins:<plugin>[;<plugin>][;<plugin>]["]]
    [["]-assemblyfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
    [["]-classfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
    [["]-filefilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
    [["]-verbosity:<Verbose|Info|Warning|Error|Off>["]]
    [["]-title:<title>["]]
    [["]-tag:<tag>["]]

Explanations:
   Reports:            The coverage reports that should be parsed (separated by semicolon).
                       Globbing is supported.
   Target directory:   The directory where the generated report should be saved.
   Report types:       The output formats and scope (separated by semicolon).
                       Values: Badges, Clover, Cobertura, CsvSummary, Html, HtmlChart, HtmlInline, 
                       HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlSummary,
                       JsonSummary, Latex, LatexSummary, lcov, MHtml, PngChart, SonarQube, TeamCitySummary,
                       TextSummary, Xml, XmlSummary
   Source directories: Optional directories which contain the corresponding source code (separated by semicolon).
                       The source directories are used if coverage report contains classes without path information.
                       Globbing is not supported.
   History directory:  Optional directory for storing persistent coverage information.
                       Can be used in future reports to show coverage evolution.
   Plugins:            Optional plugin files for custom reports or custom history storage (separated by semicolon). 
   Assembly filters:   Optional list of assemblies that should be included or excluded in the report.
   Class filters:      Optional list of classes that should be included or excluded in the report.
   File filters:       Optional list of files that should be included or excluded in the report.
                       Exclusion filters take precedence over inclusion filters.                      
                       Wildcards are allowed.
   Verbosity:          The verbosity level of the log messages.
                       Values: Verbose, Info, Warning, Error, Off
   Title:              Optional title.
   Tag:                Optional tag or build version.

Default values:
   -reporttypes:Html
   -assemblyfilters:+*
   -classfilters:+*
   -filefilters:+*
   -verbosity:Info

Examples:
   "-reports:coverage.xml" "-targetdir:C:\report"
   "-reports:target\*\*.xml" "-targetdir:C:\report" -reporttypes:Latex;HtmlSummary -title:IntegrationTest -tag:v1.4.5
   "-reports:coverage1.xml;coverage2.xml" "-targetdir:report" "-sourcedirs:C:\MyProject" -plugins:CustomReports.dll
   "-reports:coverage.xml" "-targetdir:C:\report" "-assemblyfilters:+Included;-Excluded.*"

MSBuild
A MSBuild task also exists:

<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Coverage" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
  <ItemGroup>
    <PackageReference Include="ReportGenerator" Version="x.y.z" />
  </ItemGroup>
  <Target Name="Coverage">
    <ItemGroup>
      <CoverageFiles Include="OpenCover.xml" />
    </ItemGroup>
    <ReportGenerator ReportFiles="@(CoverageFiles)" TargetDirectory="report" ReportTypes="Html;Latex" HistoryDirectory="history" Plugins="CustomReports.dll" AssemblyFilters="+Include;-Excluded" VerbosityLevel="Verbose" />
  </Target>
</Project>

Supported input and output file formats

ReportGenerator supports several input and output formats.
The wiki explains the different output formats or you can download sample reports of all formats.
If you need a custom format, you can create a plugin.

Input formats	Output formats
OpenCover (Nuget) OpenCover format is also generated by coverlet and altcover dotCover (Nuget, /ReportType=DetailedXML) Visual Studio (vstest.console.exe, CodeCoverage.exe) NCover (tested version 1.5.8, other versions may not work) Cobertura JaCoCo Clover Mono (mprof-report) gcov lcov	Html, HtmlSummary, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlChart, MHtml Clover Cobertura SonarQube TeamCitySummary lcov Xml, XmlSummary JsonSummary Latex, LatexSummary TextSummary CsvSummary PngChart Badges Custom reports

Screenshots

The screenshots show two snippets of the generated reports:

Badges
Badges in SVG and PNG format can be generated if -reporttypes:Badges is used:

Resources

Links

• https://www.palmmedia.de/Blog/2017/12/6/reportgenerator-new-release-with-risk-hotspots-analysis
• https://www.palmmedia.de/Blog/2016/11/6/reportgenerator-new-release-with-enhanced-html-report-and-cobertura-support
• https://www.palmmedia.de/Blog/2015/1/27/reportgenerator-new-beta-with-historytrend-charts
• https://www.palmmedia.de/Blog/2012/4/29/reportgenerator-new-release-with-more-advanced-report-preprocessing

Download statistics

Trends

Nuget downloads
GitHub stars

Contact

Author: Daniel Palme
Blog: www.palmmedia.de
Twitter: @danielpalme