ReportGeneratorSettings Class

Summary

Contains settings used by ReportGeneratorRunner.
Namespace
Cake.Common.Tools.ReportGenerator
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["ReportGeneratorSettings"] class Type type-node

Syntax

public sealed class ReportGeneratorSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
AssemblyFilters ICollection<string>
Gets or sets the list of assemblies that should be included or excluded in the report. Exclusion filters take precedence over inclusion filters. Wildcards are allowed.
ClassFilters ICollection<string>
Gets or sets the list of classes that should be included or excluded in the report. Exclusion filters take precedence over inclusion filters. Wildcards are allowed.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
HistoryDirectory DirectoryPath
Gets or sets the directory for storing persistent coverage information. Can be used in future reports to show coverage evolution.
ReportTypes ICollection<ReportGeneratorReportType>
Gets or sets the list of coverage reports that should be parsed.
SourceDirectories ICollection<DirectoryPath>
Gets or sets the directories which contain the corresponding source code. The source files are used if coverage report contains classes without path information.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbosity ReportGeneratorVerbosity?
Gets or sets the verbosity level of the log messages.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<ReportGeneratorSettings>() string
Get a basic string representation of specified object.
ThrowIfNull<ReportGeneratorSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<ReportGeneratorSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value