首頁>編程相關>其他源碼
下載


報告產生器

強大的程式碼覆蓋視覺化

ReportGenerator將 Coverlet、OpenCover、dotCover、Visual Studio、NCover、Cobertura、JaCoCo、Clover、gcov 或 lcov 產生的覆蓋率報告轉換為各種格式的人類可讀報告。

這些報告顯示了覆蓋率配額，並直觀地顯示了原始程式碼的哪些行已被覆蓋。

ReportGenerator 支援將多個覆蓋率檔案合併到一個報表中。

瀏覽 HTML 報告範例

執照

  • ReportGenerator 根據 Apache 授權 2.0 版獲得許可
  • 您可以透過購買 PRO 授權或成為 GitHub 贊助商來支持該專案。
    贊助商可以獨家使用附加功能。

入門

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-globaltool

dotnet tool install dotnet-reportgenerator-globaltool --tool-path tools

dotnet new tool-manifest
dotnet 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 支持

上述所有參數也可以保留在 .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 解釋了不同的輸出格式，或者您可以下載所有支援的輸出格式的範例報表。
如果您需要自訂格式，可以建立一個外掛程式。

輸入格式輸出格式
  • OpenCover (Nuget)
    OpenCover 格式也是由 coverlet 和 altcover 產生的
  • dotCover（Nuget，/ReportType=DetailedXML）
  • Visual Studio（vstest.console.exe、CodeCoverage.exe）
  • NCover（測試版本1.5.8，其他版本可能無法運作）
  • 科貝爾圖拉
  • JaCoCo（版本 0.8.3 或更高版本）
  • 三葉草
  • Mono（mprof 報告）
  • 冠狀病毒
  • 左旋病毒


  • Html、Html_Light、Html_Dark、Html_BlueRed、HtmlSummary、HtmlChart、HtmlInline、HtmlInline_AzurePipelines、HtmlInline_AzurePipelines_Light、HtmlInline_AzurePipelines_DarkzurePipelt、MturePipelt
  • 三葉草
  • 科貝爾圖拉
  • OpenCover（限專業版）
  • 聲納Qube
  • TeamCity總結
  • 左旋病毒
  • Xml, Xml總結
  • Json摘要
  • Latex, Latex總結
  • 文字摘要、文字增量摘要
  • Csv摘要
  • MarkdownSummary、MarkdownAssembliesSummary、MarkdownSummaryGithub、MarkdownDeltaSummary
  • SVG圖表
  • 徽章
  • 客製化報告

截圖

螢幕截圖顯示了產生的報告的兩個片段：

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

例子：

查看所有徽章

資源

Visual Studio 擴充

Visual Studio 中存在以下擴充功能來視覺化覆蓋範圍：

姓名覆蓋工具連結
運行床單報告 VS2022床單GitHub
市場
精細程式碼覆蓋率被單、開蓋GitHub
市場

連結

  • 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

下載統計數據

趨勢

Nuget 下載
GitHub 星星

接觸

作者：丹尼爾·帕爾梅
部落格：www.palmmedia.de
推特：@danielpalme

展開
附加信息
相關應用
爲您推薦
相關資訊 全部