Logo
Project Icon

ReportGenerator

多格式代码覆盖率报告生成和可视化工具

ReportGenerator代码覆盖率可视化测试报告开源工具Github开源项目

ReportGenerator 是一个开源的代码覆盖率报告生成工具，支持多种覆盖率格式的转换和合并。它能将 coverlet、OpenCover 等工具生成的报告转换为 HTML、XML 等易读格式，并提供源代码覆盖率可视化。该工具兼容 .NET Framework 和 .NET Core，可通过命令行、MSBuild 任务或 NuGet 包使用，为开发团队提供代码质量分析功能。

访问官网访问官网GithubGithub文档文档
介绍相关项目

ReportGenerator
ReportGenerator

强大的代码覆盖率可视化工具

GitHub license CI-CD

ReportGenerator 可以将 coverlet、OpenCover、dotCover、Visual Studio、NCover、Cobertura、JaCoCo、Clover、gcov 或 lcov 生成的覆盖率报告转换为多种格式的可读报告。

这些报告显示覆盖率指标，并可视化展示源代码中哪些行已被覆盖。

ReportGenerator 支持将多个覆盖率文件合并为一个报告。

浏览示例 HTML 报告

输入和输出

许可证

入门

ReportGenerator 是一个命令行工具，适用于完整的 .NET Framework 和 .NET Core。
使用在线配置工具可以快速入门。

安装适合您平台和需求的软件包

软件包平台安装/使用
ReportGenerator

NugetNuget		.NET Core >=6.0
.NET Framework 4.7		如果您的项目基于 .NET Framework 或 .NET Core，并且您想通过命令行或构建脚本使用 ReportGenerator，请使用此软件包。

使用方法
dotnet $(UserProfile).nuget\packages\reportgenerator\x.y.z\tools\net8.0\ReportGenerator.dll [选项]
$(UserProfile).nuget\packages\reportgenerator\x.y.z\tools\net8.0\ReportGenerator.exe [选项]

$(UserProfile)\.nuget\packages\reportgenerator\x.y.z\tools\net47\ReportGenerator.exe [选项]
dotnet-reportgenerator-globaltool

NugetNuget		.NET Core >=6.0如果您的项目基于 .NET Core，并且您想将 ReportGenerator 作为（全局）'DotnetTool' 使用，请使用此软件包。

安装
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

使用方法
reportgenerator [选项]
tools\reportgenerator.exe [选项]
dotnet reportgenerator [选项]
ReportGenerator.Core

NugetNuget		.NET Standard 2.0如果您想为 ReportGenerator 编写自定义插件，或者想在代码中调用/执行 ReportGenerator，请使用此软件包。

插件开发
自定义报告
自定义历史存储
Azure DevOps 扩展

Visual Studio Marketplace VersionVisual Studio Marketplace Installs - Azure DevOps Extension		.NET Core >=6.0将 Azure DevOps 扩展添加到您的构建管道中。
了解更多
GitHub Actions.NET Core >=6.0将 GitHub Action 添加到您的构建管道中。
了解更多

使用方法 / 命令行参数

使用在线配置工具可以快速入门。
更高级的设置在wiki中有详细说明。

参数：
    ["]-reports:<报告>[;<报告>][;<报告>]["]
    ["]-targetdir:<目标目录>["]
    [["]-reporttypes:<Html|HtmlSummary|...>[;<Html|HtmlSummary|...>]["]]
    [["]-sourcedirs:<目录>[;<目录>][;<目录>]["]]
    [["]-historydir:<历史目录>["]]
    [["]-plugins:<插件>[;<插件>][;<插件>]["]]
    [["]-assemblyfilters:<(+|-)过滤器>[;<(+|-)过滤器>][;<(+|-)过滤器>]["]]
    [["]-classfilters:<(+|-)过滤器>[;<(+|-)过滤器>][;<(+|-)过滤器>]["]]
    [["]-filefilters:<(+|-)过滤器>[;<(+|-)过滤器>][;<(+|-)过滤器>]["]]
    [["]-riskhotspotassemblyfilters:<(+|-)过滤器>[;<(+|-)过滤器>][;<(+|-)过滤器>]["]]
    [["]-riskhotspotclassfilters:<(+|-)过滤器>[;<(+|-)过滤器>][;<(+|-)过滤器>]["]]
    [["]-verbosity:<Verbose|Info|Warning|Error|Off>["]]
    [["]-title:<标题>["]]
    [["]-tag:<标签>["]]
    [["]-license:<许可证>["]]

说明：
   报告：            应解析的覆盖率报告（用分号分隔）。
                     支持通配符。
   目标目录：        生成的报告应保存的目录。
   报告类型：        输出格式和范围（用分号分隔）。
                     值：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
   源目录：          包含相应源代码的可选目录（用分号分隔）。
                     如果覆盖率报告包含没有路径信息的类，则使用源目录。
                     不支持通配符。
   历史目录：        用于存储持久性覆盖率信息的可选目录。
                     可在未来的报告中用于显示覆盖率演变。
   插件：            用于自定义报告或自定义历史存储的可选插件文件（用分号分隔）。
   程序集过滤器：    报告中应包含或排除的程序集的可选列表。
   类过滤器：        报告中应包含或排除的类的可选列表。
   文件过滤器：      报告中应包含或排除的文件的可选列表。
   风险热点程序集过滤器：风险热点中应包含或排除的程序集的可选列表。
   风险热点类过滤器：    风险热点中应包含或排除的类的可选列表。
                     排除过滤器优先于包含过滤器。
                     允许使用通配符。
   详细程度：        日志消息的详细程度。
                     值：Verbose, Info, Warning, Error, Off
   标题：            可选标题。
   标签：            可选标签或构建版本。
   许可证：          PRO版本的可选许可证。在此获取许可证：https://reportgenerator.io/pro
                     也可以通过'REPORTGENERATOR_LICENSE'环境变量提供许可证。

默认值：
   -reporttypes:Html
   -assemblyfilters:+*
   -classfilters:+*
   -filefilters:+*
   -riskhotspotassemblyfilters:+*
   -riskhotspotclassfilters:+*
   -verbosity:Info

示例：
   "-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 支持

上述所有参数也可以在 .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 添加/删除值非常简单：

# 设置单值变量
dotnet config reportgenerator.reporttypes Latex;HtmlSummary
# 向多值变量添加
dotnet config --add reportgenerator.report coverage3.xml
# 清除变量的所有多值条目
dotnet config --unset-all reportgenerator.assemblyfilter

当然，直接手动编辑 .netconfig 文件也同样简单。

MSBuild

还存在一个 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>

如果使用了 .netconfig，MSBuild 任务参数可以与之互补。这意味着如果通过 .netconfig 提供了参数，则可以在 MSBuild 任务中省略这些参数，这在跨解决方案中的多个项目重用固定设置时很有用，其中 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 解释了不同的输出格式，或者你可以下载所有支持的输出格式的示例报告。 如果你需要自定义格式，可以创建一个插件。

输入格式输出格式


  • Html, Html_Light, Html_Dark, Html_BlueRed, HtmlSummary, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Light, HtmlInline_AzurePipelines_Dark, MHtml
  • Clover
  • Cobertura
  • OpenCover (仅PRO版本)
  • SonarQube
  • TeamCitySummary
  • lcov
  • Xml, XmlSummary
  • JsonSummary
  • Latex, LatexSummary
  • TextSummary, TextDeltaSummary
  • CsvSummary
  • MarkdownSummary, MarkdownAssembliesSummary, MarkdownSummaryGithub, MarkdownDeltaSummary
  • SvgChart
  • Badges
  • 自定义报告

截图

以下截图展示了生成报告的两个片段： 截图1 截图2

徽章
如果使用-reporttypes:Badges，可以生成SVG格式的徽章：

示例：示例徽章

查看所有徽章

资源

Visual Studio扩展

以下扩展可用于在Visual Studio中可视化覆盖率：

名称覆盖率工具链接
Run Coverlet Report VS2022coverletGitHub
Marketplace
FineCodeCoveragecoverlet, OpenCoverGitHub
Marketplace

链接

下载统计

Nuget Nuget Nuget

Visual Studio Marketplace Installs - Azure DevOps Extension GitHub All Releases Chocolatey

趋势

Nuget下载量
GitHub星标

联系方式

作者：Daniel Palme
博客：www.palmmedia.de
Twitter：@danielpalme

相关项目
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手，通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能，支持100+编程语言，与主流编辑器无缝集成，显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台，能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐，Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案，通过智能技术简化视频制作流程。无论是企业宣传还是个人分享，有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持，能够阅读和理解用户上传的文件内容，解析网页信息，并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题，Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术，为商家提供一键生成商品图和营销文案的服务，显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台，让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型，免费访问各种图像生成与AI训练工具，从Stable Diffusion等基础模型开始，轻松实现创新图像生成。体验前沿的AI技术，推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器，它将改变您观看视频的方式！SubCat结合了先进的人工智能技术，为您提供即时视频字幕翻译，无论是本地视频还是网络流媒体，让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台，利用前沿AI技术，为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图，再到文案生成，美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具，简化了选题、文献检索至论文撰写的整个过程。通过简单设定，平台可快速生成高质量论文大纲和全文，配合图表、参考文献等一应俱全，同时提供开题报告和答辩PPT等增值服务，保障数据安全，有效提升写作效率和论文质量。

使用协议隐私政策广告服务
投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号