ReportGenerator

ReportGenerator

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

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

ReportGenerator代码覆盖率可视化测试报告开源工具Github开源项目
<h1 align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/1a0ec045-b3c4-4a90-99b8-8db5dcb86b55.svg" alt="ReportGenerator" width="200"/> <br/> ReportGenerator </h1> <div align="center">

<b>强大的代码覆盖率可视化工具</b>

GitHub license CI-CD

</div>

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

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

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

浏览示例 HTML 报告

<div align="center">

输入和输出

</div>

许可证

入门

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

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

软件包平台安装/使用
ReportGenerator<br/><br/>NugetNuget.NET Core >=6.0<br/>.NET Framework 4.7如果您的项目基于 .NET Framework.NET Core,并且您想通过命令行或构建脚本使用 ReportGenerator,请使用此软件包。<br/><br/>使用方法<br/>dotnet $(UserProfile).nuget\packages\reportgenerator\x.y.z\tools\net8.0\ReportGenerator.dll [选项]<br/>$(UserProfile).nuget\packages\reportgenerator\x.y.z\tools\net8.0\ReportGenerator.exe [选项]<br/><br/>$(UserProfile)\.nuget\packages\reportgenerator\x.y.z\tools\net47\ReportGenerator.exe [选项]
dotnet-reportgenerator-globaltool<br/><br/>NugetNuget.NET Core >=6.0如果您的项目基于 .NET Core,并且您想将 ReportGenerator 作为(全局)'DotnetTool' 使用,请使用此软件包。<br/><br/>安装<br/>dotnet tool install -g dotnet-reportgenerator-globaltool<br/><br/>dotnet tool install dotnet-reportgenerator-globaltool --tool-path tools<br/><br/>dotnet new tool-manifest<br/>dotnet tool install dotnet-reportgenerator-globaltool<br/><br/>使用方法<br/>reportgenerator [选项]<br/>tools\reportgenerator.exe [选项]<br/>dotnet reportgenerator [选项]
ReportGenerator.Core<br/><br/>NugetNuget.NET Standard 2.0如果您想为 ReportGenerator 编写自定义插件,或者想在代码中调用/执行 ReportGenerator,请使用此软件包。<br/><br/>插件开发<br/>自定义报告<br/>自定义历史存储
Azure DevOps 扩展<br/><br/>Visual Studio Marketplace VersionVisual Studio Marketplace Installs - Azure DevOps Extension.NET Core >=6.0将 Azure DevOps 扩展添加到您的构建管道中。<br />了解更多
GitHub Actions.NET Core >=6.0将 GitHub Action 添加到您的构建管道中。<br />了解更多

使用方法 / 命令行参数

使用在线配置工具可以快速入门。
更高级的设置在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 解释了不同的输出格式,或者你可以下载所有支持的输出格式的示例报告。 如果你需要自定义格式,可以创建一个插件

输入格式输出格式
<ul><li>OpenCover (Nuget)<br/>OpenCover格式也由coverletaltcover生成</li><li>dotCover (Nuget, /ReportType=DetailedXML)</li><li>Visual Studio (vstest.console.exe, CodeCoverage.exe)</li><li>NCover (测试版本1.5.8,其他版本可能不兼容)</li><li>Cobertura</li><li>JaCoCo (0.8.3或更高版本)</li><li>Clover</li><li>Mono (mprof-report)</li><li>gcov</li><li>lcov</li></ul><br/><br/><ul><li>Html, Html_Light, Html_Dark, Html_BlueRed, HtmlSummary, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Light, HtmlInline_AzurePipelines_Dark, MHtml</li><li>Clover</li><li>Cobertura</li><li>OpenCover (仅PRO版本)</li><li>SonarQube</li><li>TeamCitySummary</li><li>lcov</li><li>Xml, XmlSummary</li><li>JsonSummary</li><li>Latex, LatexSummary</li><li>TextSummary, TextDeltaSummary</li><li>CsvSummary</li><li>MarkdownSummary, MarkdownAssembliesSummary, MarkdownSummaryGithub, MarkdownDeltaSummary</li><li>SvgChart</li><li>Badges</li><li>自定义报告</li></ul>

截图

以下截图展示了生成报告的两个片段: <picture> <source media="(prefers-color-scheme: dark)" srcset="https://danielpalme.github.io/ReportGenerator/resources/screenshot1_dark.webp"> <img alt="截图1" src="https://yellow-cdn.veclightyear.com/835a84d5/c766399f-24d3-495e-9e27-dbcb83791c71.webp"> </picture> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://danielpalme.github.io/ReportGenerator/resources/screenshot2_dark.webp"> <img alt="截图2" src="https://yellow-cdn.veclightyear.com/835a84d5/7b96c304-aa46-45c7-bbc1-d3d225fe9fda.webp"> </picture>

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

示例:示例徽章

查看所有徽章

资源

Visual Studio扩展

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

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

链接

下载统计

Nuget Nuget Nuget

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

趋势

Nuget下载量
GitHub星标

联系方式

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

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

聊天机器人AI助手热门AI工具AI对话
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

热门AI工具AI办公办公工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多