OpenCoverSettings Class

Summary

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

Syntax

public sealed class OpenCoverSettings : ToolSettings

Constructors

Name Summary
OpenCoverSettings() Initializes a new instance of the OpenCoverSettings class.

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
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
ExcludedAttributeFilters ISet<string>
Gets attribute filters used to exclude classes or methods. This represents the -excludebyattribute option.
ExcludedFileFilters ISet<string>
Gets file filters used to excluded classes or methods. This represents the -excludebyfile option.
Filters ISet<string>
Gets the filters. This represents the -filter option.
MergeOutput bool
Gets or sets a value indicating whether to merge the results with an existing file
OldStyle bool
Gets or sets a value indicating whether the OldStyle option for OpenCover should be used
Register string
Gets or sets the register option
ReturnTargetCodeOffset int?
Gets or sets the Return target code offset to be used
SkipAutoProps bool
Gets or sets a value indicating whether or not auto-implemented properties should be skipped.
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<OpenCoverSettings>() string
Get a basic string representation of specified object.
ExcludeByAttribute(string) OpenCoverSettings
Exclude a class or method by filter that match attributes that have been applied.
ExcludeByFile(string) OpenCoverSettings
Exclude a class (or methods) by filter that match the filenames.
ThrowIfNull<OpenCoverSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<OpenCoverSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
WithFilter(string) OpenCoverSettings
Adds the filter.