DotCoverCoverSettings Class

Summary

Contains settings used by DotCoverCoverer.
graph BT Type-->Base0["DotCoverCoverageSettings"] click Base0 "/api/Cake.Common.Tools.DotCover/DotCoverCoverageSettings" Base0-->Base1["DotCoverSettings"] click Base1 "/api/Cake.Common.Tools.DotCover/DotCoverSettings" Base1-->Base2["ToolSettings"] click Base2 "/api/Cake.Core.Tooling/ToolSettings" Base2-->Base3["object"] Type["DotCoverCoverSettings"] class Type type-node

Syntax

public sealed class DotCoverCoverSettings : DotCoverCoverageSettings

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
AttributeFilters ISet<string>
Gets the attribute filters using the following syntax: filter1;filter2;... Asterisk wildcard(*) is supported here This represents the /AttributeFilters option.
ConfigFile FilePath
Gets or sets a value that enables DotCover configuration file. A configuration file is a reasonable alternative to specifying all parameters in-line or having them in a batch file.
Inherited from DotCoverSettings
DisableDefaultFilters bool
Gets or sets a value indicating whether the default (automatically added) filters should be disabled This represents the /DisableDefaultFilters option.
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
Filters ISet<string>
Gets the coverage filters using the following syntax: +:module=*;class=*;function=*; Use -:myassembly to exclude an assembly from code coverage. Asterisk wildcard (*) is supported here. This represents the /Filters option.
LogFile FilePath
Gets or sets a value that enables logging and specifies log file name This represents the /LogFile option.
Inherited from DotCoverSettings
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
Inherited from ToolSettings
ProcessFilters ISet<string>
Gets the coverage process filters using the following syntax: +:test.exe;program.exe*; Use -:anexe to exclude an assembly from code coverage. This represents the /ProcessFilters option.
Scope ISet<string>
Gets the assemblies loaded in the specified scope into coverage results. Ant-style patterns are supported here (e.g.ProjectFolder/**/*.dll) This represents the /Scope option.
TargetWorkingDir DirectoryPath
Gets or sets program working directory This represents the /TargetWorkingDir option.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<DotCoverCoverSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotCoverCoverSettings>(DotCoverCoverSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotCoverCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DotCoverCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DotCoverCoverSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DotCoverCoverSettings>(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
WithAttributeFilter<DotCoverCoverSettings>(string) T
Adds the attribute filter
WithConfigFile<DotCoverCoverSettings>(FilePath) T
Adds the scope.
WithFilter<DotCoverCoverSettings>(string) T
Adds the filter
WithProcessFilter<DotCoverCoverSettings>(string) T
Adds the filter
WithScope<DotCoverCoverSettings>(string) T
Adds the scope.