CoverletSettings Class

Summary

Settings used by Cake.Coverlet
Assembly
Cake.Coverlet.dll
Namespace
Cake.Coverlet
Base Types
  • DotNetCoreSettings
graph BT Type-->Base0["DotNetCoreSettings"] Type["CoverletSettings"] class Type type-node

Syntax

public class CoverletSettings : DotNetCoreSettings

Constructors

Name Summary
CoverletSettings()

Properties

Name Value Summary
CollectCoverage bool
Gets or sets if coverage should be collected
CoverletOutputDirectory DirectoryPath
Gets or sets the output directory the output files
CoverletOutputFormat CoverletOutputFormat
Gets or sets the output format for Coverlet
CoverletOutputName string
Gets or sets the name of the output file excluding format
Exclude List<string>
Gets or sets the exclusion filters
ExcludeByAttribute List<string>
Gets or sets the list of files to exclude
ExcludeByFile List<string>
Gets or sets the list of files to exclude
Include List<string>
Gets or sets a inclusion filters
IncludeTestAssembly Nullable<bool>
Gets or sets if the test assembly should be included
MergeWithFile FilePath
Gets or sets the file to merge the results of the run with
OutputTransformer OutputTransformer
Gets or sets a transformation function taking the CoverletOutputName and returning the new file name without an extension
Threshold Nullable<uint>
Gets or sets the threshold for Coverlet to use in percent
ThresholdType ThresholdType
Gets or sets the type of threshold to apply.

Methods

Name Value Summary
Clone() CoverletSettings
Clones the coverlet settings to a new instance
SetFormat(CoverletOutputFormat) CoverletSettings
Sets the output format to be a specific value
WithAttributeExclusion(string) CoverletSettings
Adds a attribute to the list of attribute to exclude
WithDateTimeTransformer() CoverletSettings
Add a default transformer appending the current date time at the time of calling test
WithFileExclusion(string) CoverletSettings
Adds a file to the list of files to exclude
WithFilter(string) CoverletSettings
Adds a filter to the list of exclusions
WithFormat(CoverletOutputFormat) CoverletSettings
Add a type of format to combine with the existing output formats
WithIncludeTestAssembly(bool) CoverletSettings
Sets the output format to be a specific value
WithInclusion(string) CoverletSettings
Adds a filter to the list of inclusions
WithThresholdType(ThresholdType) CoverletSettings
Add a type of threshold to combine with the existing

Extension Methods

Name Value Summary
Dump<CoverletSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CoverletSettings>(CoverletSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CoverletSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CoverletSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CoverletSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CoverletSettings>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin