ReportGenerator
ReportGenerator_5.4.1
强大的代码覆盖可视化
ReportGenerator将 Coverlet、OpenCover、dotCover、Visual Studio、NCover、Cobertura、JaCoCo、Clover、gcov 或 lcov 生成的覆盖率报告转换为各种格式的人类可读报告。
这些报告显示了覆盖率配额，并直观地显示了源代码的哪些行已被覆盖。
ReportGenerator 支持将多个覆盖率文件合并到一个报告中。
浏览 HTML 报告示例
ReportGenerator是一个命令行工具，可与完整的 .NET Framework 和 .NET Core 配合使用。
使用在线配置工具快速上手。
| 包裹 | 平台 | 安装/使用 |
|---|---|---|
| 报告生成器 | .NET 核心 >=8.0 .NET框架4.7 | 如果您的项目基于.NET Framework或.NET Core并且您希望通过命令行或构建脚本使用ReportGenerator ，请使用此包。 用法 dotnet $(UserProfile).nugetpackagesreportgeneratorxyztoolsnet8.0ReportGenerator.dll [options]$(UserProfile).nugetpackagesreportgeneratorxyztoolsnet8.0ReportGenerator.exe [options]$(UserProfile).nugetpackagesreportgeneratorxyztoolsnet47ReportGenerator.exe [options] |
| dotnet-报告生成器-globaltool | .NET 核心 >=8.0 | 如果您的项目基于.NET Core并且您希望将ReportGenerator用作（全局）“DotnetTool”，请使用此包。 安装 dotnet tool install -g dotnet-reportgenerator-globaltooldotnet tool install dotnet-reportgenerator-globaltool --tool-path toolsdotnet new tool-manifestdotnet tool install dotnet-reportgenerator-globaltool用法 reportgenerator [options]toolsreportgenerator.exe [options]dotnet reportgenerator [options] |
| 报告生成器.Core | .NET 标准 2.0 | 如果您想为ReportGenerator编写自定义插件，或者想在代码库中调用/执行ReportGenerator，请使用此包。 插件开发 定制报告 自定义历史存储 |
| Azure DevOps 扩展 | .NET 核心 >=8.0 | 将 Azure DevOps 扩展添加到构建管道。 了解更多 |
| GitHub 操作 | .NET 核心 >=8.0 | 将 GitHub Action 添加到您的构建管道。 了解更多 |
使用在线配置工具快速上手。
更高级的设置记录在 wiki 中。
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>]["]]
[["]-riskhotspotassemblyfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
[["]-riskhotspotclassfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
[["]-verbosity:<Verbose|Info|Warning|Error|Off>["]]
[["]-title:<title>["]]
[["]-tag:<tag>["]]
[["]-license:<license>["]]
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,
MarkdownSummary, MarkdownAssembliesSummary, MarkdownSummaryGithub, MarkdownDeltaSummary
OpenCover
Html, Html_Light, Html_Dark, Html_BlueRed
HtmlChart, HtmlInline, HtmlSummary, Html_BlueRed_Summary
HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Light, HtmlInline_AzurePipelines_Dark
JsonSummary, CodeClimate, Latex, LatexSummary, lcov, MHtml, SvgChart, SonarQube, TeamCitySummary
TextSummary, TextDeltaSummary
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.
Risk hotspot assembly filters: Optional list of assemblies that should be included or excluded in the risk hotspots.
Risk hotspot class filters: Optional list of classes that should be included or excluded in the risk hotspots.
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.
License: Optional license for PRO version. Get your license here: https://reportgenerator.io/pro
License can also be supplied via 'REPORTGENERATOR_LICENSE' environment variable.
Default values:
-reporttypes:Html
-assemblyfilters:+*
-classfilters:+*
-filefilters:+*
-riskhotspotassemblyfilters:+*
-riskhotspotclassfilters:+*
-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.*"
上述所有参数也可以保留在 .netconfig 文件中的[ReportGenerator]部分下。示例：
[ ReportGenerator ]
reports = coverage.xml
targetdir = " C: \ report "
reporttypes = Latex,HtmlSummary
assemblyfilters = +Test,-Test
classfilters = +Test2,-Test2所有复数选项也可以指定为多个单数条目，例如：
[ ReportGenerator ]
report = coverage1.xml
report = coverage2.xml
reporttype = Latex
reporttype = HtmlSummary
assemblyfilter = +Test
assemblyfilter = -Test
classfilter = +Test2
classfilter = -Test2
filefilter = +cs
filefilter = -vb
riskhotspotassemblyfilter = +Test
riskhotspotassemblyfilter = -Test
riskhotspotclassfilter = +Test2
riskhotspotclassfilter = -Test2
sourcedir = src
sourcedir = test使用 dotnet-config CLI 添加/删除值非常简单：
# set a single-valued variable
dotnet config reportgenerator.reporttypes Latex ; HtmlSummary
# add to multi-valued variable
dotnet config --add reportgenerator.report coverage3.xml
# clear all multi-valued entries for a variable
dotnet config --unset-all reportgenerator.assemblyfilter当然，手动编辑.netconfig文件也同样简单。
还存在 MSBuild 任务：
<? 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 ProjectDirectory = " $(MSBuildProjectDirectory) " ReportFiles = " @(CoverageFiles) " TargetDirectory = " report " ReportTypes = " Html;Latex " HistoryDirectory = " history " Plugins = " CustomReports.dll " AssemblyFilters = " +Include;-Excluded " VerbosityLevel = " Verbose " />
</ Target >
</ Project > MSBuild 任务参数可以通过.netconfig进行补充（如果使用）。这意味着如果通过.netconfig提供参数，则可以省略参数，这在解决方案中跨多个项目重用固定设置时非常有用，其中 MSBuild 任务仅提供当前项目的动态值：
给定以下.netconfig ：
[ ReportGenerator ]
reporttypes = Html ; Latex
targetdirectory = report
historydirectory = history
assemblyfilters = +Include ; -Excluded
verbosityLevel = Verbose上述目标可以简化为：
< Target Name = " Coverage " >
< ItemGroup >
< CoverageFiles Include = " OpenCover.xml " />
</ ItemGroup >
< ReportGenerator ProjectDirectory = " $(MSBuildProjectDirectory) "
ReportFiles = " @(CoverageFiles) "
Plugins = " CustomReports.dll " />
</ Target >ReportGenerator支持多种输入和输出格式。
该 wiki 解释了不同的输出格式，或者您可以下载所有支持的输出格式的示例报告。
如果您需要自定义格式，可以创建一个插件。
| 输入格式 | 输出格式 |
|---|---|
|
|
屏幕截图显示了生成的报告的两个片段：
徽章
如果使用-reporttypes:Badges Badges 则可以生成 SVG 格式的徽章：
例子：
查看所有徽章
Visual Studio 中存在以下扩展来可视化覆盖范围：
| 姓名 | 覆盖工具 | 链接 |
|---|---|---|
| 运行床单报告 VS2022 | 床单 | GitHub 市场 |
| 精细代码覆盖率 | 被单、开盖 | GitHub 市场 |
Nuget 下载
GitHub 星星
作者：丹尼尔·帕尔梅
博客：www.palmmedia.de
推特：@danielpalme
