From b1c2b2f9d6fa9748f6f66da6d26aef0d652008df Mon Sep 17 00:00:00 2001 From: danielpalme Date: Sat, 23 Nov 2019 15:54:20 +0100 Subject: [PATCH] Documentation --- README.md | 4 ++-- docs/usage.html | 1 + .../nuget/dotnet-reportgenerator-cli.nuspec | 12 ++++++++++-- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c7fe7057..2386ffc4 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ Use the online [configuration tool](https://danielpalme.github.io/ReportGenerato |**Package**|**Platforms**|**Installation/Usage**| |:----------|:------------|:---------------------| |[ReportGenerator](https://www.nuget.org/packages/ReportGenerator)

[![Nuget](https://img.shields.io/nuget/v/ReportGenerator.svg)![Nuget](https://img.shields.io/nuget/dt/ReportGenerator.svg)](https://www.nuget.org/packages/ReportGenerator)|.NET Core 2.0
.NET Framework 4.7|Use this package if your project is based on *.NET Framework* or *.NET Core* and you want to use *ReportGenerator* via the command line or a build script.

**Usage**
```$(UserProfile)\.nuget\packages\reportgenerator\x.y.z\tools\net47\ReportGenerator.exe [options]```

```dotnet $(UserProfile).nuget\packages\reportgenerator\x.y.z\tools\netcoreapp2.1\ReportGenerator.dll [options]```| -|[dotnet-reportgenerator-cli](https://www.nuget.org/packages/dotnet-reportgenerator-cli)

[![Nuget](https://img.shields.io/nuget/v/dotnet-reportgenerator-cli.svg)![Nuget](https://img.shields.io/nuget/dt/dotnet-reportgenerator-cli.svg)](https://www.nuget.org/packages/dotnet-reportgenerator-cli)|.NET Core 2.0|Use this package if your project is based on *.NET Core* and you want to use *ReportGenerator* as a 'DotnetCliTool'.

**Installation**
Add `` to your project file.

**Usage**
```dotnet reportgenerator [options]```| |[dotnet-reportgenerator-globaltool](https://www.nuget.org/packages/dotnet-reportgenerator-globaltool)

[![Nuget](https://img.shields.io/nuget/v/dotnet-reportgenerator-globaltool.svg)![Nuget](https://img.shields.io/nuget/dt/dotnet-reportgenerator-globaltool.svg)](https://www.nuget.org/packages/dotnet-reportgenerator-globaltool)|.NET Core 2.1|Use this package if your project is based on *.NET Core* and you want to use *ReportGenerator* as a (global) 'DotnetTool'.

**Installation**
```dotnet tool install -g dotnet-reportgenerator-globaltool```
```dotnet tool install dotnet-reportgenerator-globaltool --tool-path tools```

**Usage**
```reportgenerator [options]```
```tools\reportgenerator.exe [options]```| +|[dotnet-reportgenerator-cli](https://www.nuget.org/packages/dotnet-reportgenerator-cli)

[![Nuget](https://img.shields.io/nuget/v/dotnet-reportgenerator-cli.svg)![Nuget](https://img.shields.io/nuget/dt/dotnet-reportgenerator-cli.svg)](https://www.nuget.org/packages/dotnet-reportgenerator-cli)|.NET Core 2.0|Use this package if your project is based on *.NET Core 2.x* and you want to use *ReportGenerator* as a 'DotnetCliTool'.

**Warning**
This package is intended for *.NET Core 2.x*. It will not work with .NET Core 3.x.
Consider the [dotnet-reportgenerator-globaltool](https://www.nuget.org/packages/dotnet-reportgenerator-globaltool) for *.NET Core 3.x*.

**Installation**
Add `` to your project file.

**Usage**
```dotnet reportgenerator [options]```| |[ReportGenerator.Core](https://www.nuget.org/packages/ReportGenerator.Core)

[![Nuget](https://img.shields.io/nuget/v/ReportGenerator.Core.svg)![Nuget](https://img.shields.io/nuget/dt/ReportGenerator.Core.svg)](https://www.nuget.org/packages/ReportGenerator.Core)|.NET Standard 2.0|Use this package if you want to write a custom **plugin** for *ReportGenerator* or if you want to call/execute *ReportGenerator* within your code base.

**Plugin development**
[Custom reports](https://github.com/danielpalme/ReportGenerator/wiki/Custom-reports)
[Custom history storage](https://github.com/danielpalme/ReportGenerator/wiki/Custom-history-storage)| |[Azure DevOps extension](https://marketplace.visualstudio.com/items?itemName=Palmmedia.reportgenerator)

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/Palmmedia.reportgenerator.svg)![Visual Studio Marketplace Installs - Azure DevOps Extension](https://img.shields.io/visual-studio-marketplace/azure-devops/installs/total/Palmmedia.reportgenerator.svg)](https://marketplace.visualstudio.com/items?itemName=Palmmedia.reportgenerator)|.NET Core 2.1| Add the Azure DevOps extension to your build pipeline.
[Learn more](https://github.com/danielpalme/ReportGenerator/wiki/Integration#azure-devops-extension)| @@ -119,7 +119,7 @@ If you need a custom format, you can create a [plugin](https://github.com/daniel | **Input formats** | **Output formats** | |:------------------|:-------------------| -|
  • [OpenCover](https://github.com/OpenCover/opencover) ([Nuget](https://www.nuget.org/packages/OpenCover))
    OpenCover format is also generated by [coverlet](https://github.com/tonerdo/coverlet/) and [altcover](https://github.com/SteveGilham/altcover)
  • [dotCover](https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html) ([Nuget](https://www.nuget.org/packages/JetBrains.dotCover.CommandLineTools/), /ReportType=DetailedXML)
  • Visual Studio ([vstest.console.exe](https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#vstestconsoleexe), [CodeCoverage.exe](https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#codecoverageexe))
  • [NCover](https://www.ncover.com/info/download) (tested version 1.5.8, other versions may not work)
  • [Cobertura](https://github.com/cobertura/cobertura)
  • [JaCoCo](https://www.jacoco.org/jacoco/index.html)
  • [Clover](https://openclover.org/)
  • Mono ([mprof-report](https://www.mono-project.com/docs/debug+profile/profile/profiler/#analyzing-the-profile-data))
  • [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html)
  • [lcov](https://github.com/linux-test-project/lcov)
|
  • HTML, HTMLSummary, HTMLInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HTMLChart, [MHTML](https://en.wikipedia.org/wiki/MHTML)
  • Cobertura
  • [SonarQube](https://docs.sonarqube.org/latest/analysis/generic-test)
  • [lcov](https://github.com/linux-test-project/lcov)
  • XML, XMLSummary
  • Latex, LatexSummary
  • TextSummary
  • CsvSummary
  • PngChart
  • Badges
  • [Custom reports](https://github.com/danielpalme/ReportGenerator/wiki/Custom-reports)

| +|
  • [OpenCover](https://github.com/OpenCover/opencover) ([Nuget](https://www.nuget.org/packages/OpenCover))
    OpenCover format is also generated by [coverlet](https://github.com/tonerdo/coverlet/) and [altcover](https://github.com/SteveGilham/altcover)
  • [dotCover](https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html) ([Nuget](https://www.nuget.org/packages/JetBrains.dotCover.CommandLineTools/), /ReportType=DetailedXML)
  • Visual Studio ([vstest.console.exe](https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#vstestconsoleexe), [CodeCoverage.exe](https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#codecoverageexe))
  • [NCover](https://www.ncover.com/info/download) (tested version 1.5.8, other versions may not work)
  • [Cobertura](https://github.com/cobertura/cobertura)
  • [JaCoCo](https://www.jacoco.org/jacoco/index.html)
  • [Clover](https://openclover.org/)
  • Mono ([mprof-report](https://www.mono-project.com/docs/debug+profile/profile/profiler/#analyzing-the-profile-data))
  • [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html)
  • [lcov](https://github.com/linux-test-project/lcov)
|
  • HTML, HTMLSummary, HTMLInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HTMLChart, [MHTML](https://en.wikipedia.org/wiki/MHTML)
  • Cobertura
  • [SonarQube](https://docs.sonarqube.org/latest/analysis/generic-test)
  • [lcov](https://github.com/linux-test-project/lcov)
  • XML, XMLSummary
  • Latex, LatexSummary
  • TextSummary
  • CsvSummary
  • PngChart
  • Badges
  • [Custom reports](https://github.com/danielpalme/ReportGenerator/wiki/Custom-reports)


| ### Screenshots The screenshots show two snippets of the generated reports: diff --git a/docs/usage.html b/docs/usage.html index 2bf3524b..683c7bee 100644 --- a/docs/usage.html +++ b/docs/usage.html @@ -232,6 +232,7 @@

Usage

{ name: 'MHTML', description: 'Same as HTML but packaged into a single MHTML file.', requiresHistoryDir: false, checked: false }, { name: 'Cobertura', description: 'Creates a XML file in Cobertura format. This format integrates with tools like Azure DevOps (VSTS) or Jenkins.', requiresHistoryDir: false, checked: false }, { name: 'SonarQube', description: 'Creates a XML file in SonarQube \'Generic Test Data\' format.', requiresHistoryDir: false, checked: false }, + { name: 'lcov', description: 'Creates a text file in \'lcov\' format.', requiresHistoryDir: false, checked: false }, { name: 'XML', description: 'Creates a XML file containing a summary for all classes and detailed reports for each class.', requiresHistoryDir: false, checked: false }, { name: 'XMLSummary', description: 'Creates a single XML file containing a summary for all classes.', requiresHistoryDir: false, checked: false }, { name: 'Latex', description: 'Creates a single TEX file containing a summary for all classes and detailed reports for each class.', requiresHistoryDir: false, checked: false }, diff --git a/src/Deployment/nuget/dotnet-reportgenerator-cli.nuspec b/src/Deployment/nuget/dotnet-reportgenerator-cli.nuspec index 4b91ab7e..af65fc1c 100644 --- a/src/Deployment/nuget/dotnet-reportgenerator-cli.nuspec +++ b/src/Deployment/nuget/dotnet-reportgenerator-cli.nuspec @@ -13,7 +13,12 @@ ReportGenerator converts coverage reports generated by OpenCover, dotCover, Visual Studio, NCover, Cobertura, JaCoCo, Clover, gcov or lcov or into human readable reports in various formats. The reports do not only show the coverage quota, but also include the source code and visualize which line has been covered. ReportGenerator converts coverage reports generated by OpenCover, dotCover, Visual Studio, NCover, Cobertura, JaCoCo, Clover, gcov or lcov or into human readable reports in various formats. The reports do not only show the coverage quota, but also include the source code and visualize which line has been covered. -Use this package if your project is based on .NET Core and you want to use ReportGenerator as a 'DotnetCliTool'. +Use this package if your project is based on .NET Core 2.x and you want to use ReportGenerator as a 'DotnetCliTool'. + +Warning: +This package is intended for .NET Core 2.x. It will not work with .NET Core 3.x. +Consider the dotnet-reportgenerator-globaltool for .NET Core 3.x: +https://www.nuget.org/packages/dotnet-reportgenerator-globaltool Installation: Add the following element to your project file: @@ -42,4 +47,7 @@ dotnet reportgenerator [options] - \ No newline at end of file + + + +