repository·main·Indexed 25 days ago
https://github.com/danielpalme/reportgeneratorA tool that converts code coverage report formats—including coverlet, OpenCover, dotCover, Visual Studio, NCover, Cobertura, JaCoCo, Clover, gcov, and lcov—into human-readable visualizations. It supports merging multiple coverage files into a single report and provides various output formats such as HTML, Markdown, Cobertura, and JsonSummary. ReportGenerator can be used as a .NET global tool, NuGet package, MSBuild task, Azure DevOps extension, or GitHub Action.
ReportGenerator is a tool for powerful code coverage visualization. It converts coverage reports generated by various tools into human-readable reports in multiple formats. It also supports merging several coverage files into a single unified report.
Supported input formats include:
ReportGenerator converts coverage reports generated by various tools into human-readable reports in multiple formats. It visualizes covered lines of source code and displays coverage quotas.
Supported input formats include:
Select the package that matches your platform and integration needs:
The ReportGenerator.Core package is intended for developers who need to extend ReportGenerator or integrate it directly into their own software. Use this package if you want to:
For guidance on implementing custom reports or custom history storage, refer to the official wiki documentation.
If your goal is simply to generate coverage reports (rather than developing plugins or integrating the core logic), do not use the .Core package. Instead, use one of the following packages depending on your needs:
ReportGenerator for integration into your projects.dotnet-reportgenerator-globaltool to run ReportGenerator from the command line via the dotnet CLI.You can use the reportgenerator@5 task in your Azure DevOps YAML pipelines to parse coverage reports and generate output in desired formats.
Key Inputs:
reports: (Required) The coverage reports to parse (separated by semicolon; globbing supported).targetdir: (Required) The directory where the generated report will be saved.reporttypes: The output formats (separated by semicolon). Examples include HtmlInline_AzurePipelines, Cobertura, Html, JsonSummary, etc.publishCodeCoverageResults: Set to true to directly publish the report in the 'Code Coverage' tab of Azure DevOps, making the separate PublishCodeCoverageResults task unnecessary.- task: reportgenerator@5
displayName: ReportGenerator
inputs:
reports: 'coverage.xml' # REQUIRED
targetdir: 'coveragereport' # REQUIRED
reporttypes: 'HtmlInline_AzurePipelines;Cobertura'
publishCodeCoverageResults: trueYou can install the dotnet-reportgenerator-globaltool package in three ways depending on your environment requirements:
tools) using the --tool-path flag.ReportGenerator.Core NuGet package if you want to write a custom plugin for ReportGenerator or if you want to call/execute ReportGenerator within your code base. This package targets .NET Standard 2.0.If you are using the ReportGenerator package on .NET Framework, execute the tool using the EXE located in the net47 tools directory within your NuGet packages folder. Replace [options] with your specific command line parameters.
$(UserProfile)\.nuget\packages\reportgenerator\5.5.11\tools\net47\ReportGenerator.exe [options]If you are using the ReportGenerator package on .NET Core, you can execute the tool by pointing to the DLL or EXE located in your NuGet packages folder. Replace [options] with your specific command line parameters.
dotnet $(UserProfile)\.nuget\packages\reportgenerator\5.5.11\tools\net10.0\ReportGenerator.dll [options]
$(UserProfile)\.nuget\packages\reportgenerator\5.5.11\tools\net10.0\ReportGenerator.exe [options]Execute unit tests using the Karma test runner with the command ng test.
Execute end-to-end tests using ng e2e. Note that you must first install a package that provides end-to-end testing capabilities (such as Cypress or Protractor) for this command to function.