ReportGeneratorRunner Class

Summary

ReportGenerator runner.
Namespace
Cake.Common.Tools.ReportGenerator
Base Types
graph BT Type-->Base0["Tool<ReportGeneratorSettings>"] Base0-->Base1["object"] Type["ReportGeneratorRunner"] class Type type-node

Syntax

public sealed class ReportGeneratorRunner : Tool<ReportGeneratorSettings>

Constructors

Name Summary
ReportGeneratorRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the ReportGeneratorRunner class.

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
Run(IEnumerable<FilePath>, DirectoryPath, ReportGeneratorSettings) void
Converts the specified coverage reports into human readable form according to the specified settings.

Extension Methods

Name Value Summary
Dump<ReportGeneratorRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ReportGeneratorRunner>(ReportGeneratorRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ReportGeneratorRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<ReportGeneratorRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<ReportGeneratorRunner>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ReportGeneratorRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin