/// <summary>
/// <p>ReportGenerator converts XML reports generated by OpenCover, PartCover, dotCover, Visual Studio, NCover or Cobertura into human readable reports in various formats.</p><p>The reports do not only show the coverage quota, but also include the source code and visualize which lines have been covered.</p><p>ReportGenerator supports merging several reports into one. It is also possible to pass one XML file containing several reports to ReportGenerator (e.g. a build log file).</p><p>The following <a href="https://github.com/danielpalme/ReportGenerator/wiki/Output-formats">output formats</a> are supported by ReportGenerator:<ul><li>HTML, HTMLSummary, HTMLInline, HTMLChart, <a href="https://en.wikipedia.org/wiki/MHTML">MHTML</a></li><li>XML, XMLSummary</li><li>Latex, LatexSummary</li><li>TextSummary</li><li>CsvSummary</li><li>PngChart</li><li>Badges</li><li><a href="https://github.com/danielpalme/ReportGenerator/wiki/Custom-reports">Custom reports</a></li></ul></p><p>Compatibility:<ul><li><a href="https://github.com/OpenCover/opencover">OpenCover</a></li><li><a href="https://github.com/sawilde/partcover.net4">PartCover 4.0</a></li><li><a href="http://sourceforge.net/projects/partcover">PartCover 2.2, 2.3</a></li><li><a href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html">dotCover</a> (/ReportType=DetailedXML)</li><li>Visual Studio (<a href="https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#vstestconsoleexe">vstest.console.exe</a>, <a href="https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#codecoverageexe">CodeCoverage.exe</a>)</li><li><a href="http://www.ncover.com/download/current">NCover</a> (tested version 1.5.8, other versions may not work)</li><li><a href="https://github.com/cobertura/cobertura">Cobertura</a></li><li>Mono (<a href="http://www.mono-project.com/docs/debug+profile/profile/profiler/#analyzing-the-profile-data">mprof-report</a>)</li></ul></p>
/// <p>For more details, visit the <a href="https://github.com/danielpalme/ReportGenerator">official website</a>.</p>
/// </summary>
/// <remarks>
/// <p>This is a <a href="http://www.nuke.build/docs/authoring-builds/cli-tools.html#fluent-apis">CLI wrapper with fluent API</a> that allows to modify the following arguments:</p>
/// <ul>
/// <li><c>-assemblyfilters</c> via <see cref="ReportGeneratorSettings.AssemblyFilters"/></li>
/// <li><c>-classfilters</c> via <see cref="ReportGeneratorSettings.ClassFilters"/></li>
/// <li><c>-filefilters</c> via <see cref="ReportGeneratorSettings.FileFilters"/></li>
/// <li><c>-historydir</c> via <see cref="ReportGeneratorSettings.HistoryDirectory"/></li>
/// <li><c>-reports</c> via <see cref="ReportGeneratorSettings.Reports"/></li>
/// <li><c>-reporttypes</c> via <see cref="ReportGeneratorSettings.ReportTypes"/></li>
/// <li><c>-sourcedirs</c> via <see cref="ReportGeneratorSettings.SourceDirectories"/></li>
/// <li><c>-tag</c> via <see cref="ReportGeneratorSettings.Tag"/></li>
/// <li><c>-targetdir</c> via <see cref="ReportGeneratorSettings.TargetDirectory"/></li>
/// <li><c>-verbosity</c> via <see cref="ReportGeneratorSettings.Verbosity"/></li>
/// </ul>
/// </remarks>
public static IReadOnlyCollection <LineOutColored> ReportGenerator(ReportGeneratorSettings toolSettings = null)
{
toolSettings = toolSettings ?? new ReportGeneratorSettings();
using var process = ProcessTasks.StartProcess(toolSettings);
process.AssertZeroExitCode();
return(process.Output);
}
public static ReportGeneratorSettings RemoveSourceDirectories(this ReportGeneratorSettings toolSettings, IEnumerable <string> sourceDirectories)
{
toolSettings = toolSettings.NewInstance();
var hashSet = new HashSet <string>(sourceDirectories);
toolSettings.SourceDirectoriesInternal.RemoveAll(x => hashSet.Contains(x));
return(toolSettings);
}
public static ReportGeneratorSettings RemoveReportTypes(this ReportGeneratorSettings toolSettings, IEnumerable <ReportTypes> reportTypes)
{
toolSettings = toolSettings.NewInstance();
var hashSet = new HashSet <ReportTypes>(reportTypes);
toolSettings.ReportTypesInternal.RemoveAll(x => hashSet.Contains(x));
return(toolSettings);
}
public static ReportGeneratorSettings RemoveClassFilters(this ReportGeneratorSettings toolSettings, params string[] classFilters)
{
toolSettings = toolSettings.NewInstance();
var hashSet = new HashSet <string>(classFilters);
toolSettings.ClassFiltersInternal.RemoveAll(x => hashSet.Contains(x));
return(toolSettings);
}
public static ReportGeneratorSettings RemoveFileFilters(this ReportGeneratorSettings toolSettings, IEnumerable <string> fileFilters)
{
toolSettings = toolSettings.NewInstance();
var hashSet = new HashSet <string>(fileFilters);
toolSettings.FileFiltersInternal.RemoveAll(x => hashSet.Contains(x));
return(toolSettings);
}
public static ReportGeneratorSettings AddClassFilters(this ReportGeneratorSettings toolSettings, params string[] classFilters)
{
toolSettings = toolSettings.NewInstance();
toolSettings.ClassFiltersInternal.AddRange(classFilters);
return(toolSettings);
}
public static ReportGeneratorSettings SetClassFilters(this ReportGeneratorSettings toolSettings, params string[] classFilters)
{
toolSettings = toolSettings.NewInstance();
toolSettings.ClassFiltersInternal = classFilters.ToList();
return(toolSettings);
}
public static ReportGeneratorSettings ResetHistoryDirectory(this ReportGeneratorSettings toolSettings)
{
toolSettings = toolSettings.NewInstance();
toolSettings.HistoryDirectory = null;
return(toolSettings);
}
public static ReportGeneratorSettings AddReports(this ReportGeneratorSettings toolSettings, params string[] reports)
{
toolSettings = toolSettings.NewInstance();
toolSettings.ReportsInternal.AddRange(reports);
return(toolSettings);
}
public static ReportGeneratorSettings SetTag(this ReportGeneratorSettings toolSettings, string tag)
{
toolSettings = toolSettings.NewInstance();
toolSettings.Tag = tag;
return(toolSettings);
}
public static ReportGeneratorSettings ClearFileFilters(this ReportGeneratorSettings toolSettings)
{
toolSettings = toolSettings.NewInstance();
toolSettings.FileFiltersInternal.Clear();
return(toolSettings);
}
public static ReportGeneratorSettings AddSourceDirectories(this ReportGeneratorSettings toolSettings, IEnumerable <string> sourceDirectories)
{
toolSettings = toolSettings.NewInstance();
toolSettings.SourceDirectoriesInternal.AddRange(sourceDirectories);
return(toolSettings);
}
public static ReportGeneratorSettings SetSourceDirectories(this ReportGeneratorSettings toolSettings, IEnumerable <string> sourceDirectories)
{
toolSettings = toolSettings.NewInstance();
toolSettings.SourceDirectoriesInternal = sourceDirectories.ToList();
return(toolSettings);
}
public static ReportGeneratorSettings AddReportTypes(this ReportGeneratorSettings toolSettings, IEnumerable <ReportTypes> reportTypes)
{
toolSettings = toolSettings.NewInstance();
toolSettings.ReportTypesInternal.AddRange(reportTypes);
return(toolSettings);
}
public static ReportGeneratorSettings SetReportTypes(this ReportGeneratorSettings toolSettings, IEnumerable <ReportTypes> reportTypes)
{
toolSettings = toolSettings.NewInstance();
toolSettings.ReportTypesInternal = reportTypes.ToList();
return(toolSettings);
}
public static ReportGeneratorSettings SetTargetDirectory(this ReportGeneratorSettings toolSettings, string targetDirectory)
{
toolSettings = toolSettings.NewInstance();
toolSettings.TargetDirectory = targetDirectory;
return(toolSettings);
}
public static ReportGeneratorSettings SetFileFilters(this ReportGeneratorSettings toolSettings, IEnumerable <string> fileFilters)
{
toolSettings = toolSettings.NewInstance();
toolSettings.FileFiltersInternal = fileFilters.ToList();
return(toolSettings);
}
public static ReportGeneratorSettings AddFileFilters(this ReportGeneratorSettings toolSettings, IEnumerable <string> fileFilters)
{
toolSettings = toolSettings.NewInstance();
toolSettings.FileFiltersInternal.AddRange(fileFilters);
return(toolSettings);
}
public static ReportGeneratorSettings ClearSourceDirectories(this ReportGeneratorSettings toolSettings)
{
toolSettings = toolSettings.NewInstance();
toolSettings.SourceDirectoriesInternal.Clear();
return(toolSettings);
}
public static ReportGeneratorSettings SetVerbosity(this ReportGeneratorSettings toolSettings, ReportGeneratorVerbosity verbosity)
{
toolSettings = toolSettings.NewInstance();
toolSettings.Verbosity = verbosity;
return(toolSettings);
}
static partial void PostProcess(ReportGeneratorSettings toolSettings);
public static ReportGeneratorSettings ResetTag(this ReportGeneratorSettings toolSettings)
{
toolSettings = toolSettings.NewInstance();
toolSettings.Tag = null;
return(toolSettings);
}
public static ReportGeneratorSettings SetReports(this ReportGeneratorSettings toolSettings, params string[] reports)
{
toolSettings = toolSettings.NewInstance();
toolSettings.ReportsInternal = reports.ToList();
return(toolSettings);
}
public static ReportGeneratorSettings ResetVerbosity(this ReportGeneratorSettings toolSettings)
{
toolSettings = toolSettings.NewInstance();
toolSettings.Verbosity = null;
return(toolSettings);
}
public static ReportGeneratorSettings SetHistoryDirectory(this ReportGeneratorSettings toolSettings, string historyDirectory)
{
toolSettings = toolSettings.NewInstance();
toolSettings.HistoryDirectory = historyDirectory;
return(toolSettings);
}