MiniCoverSettings Class

Summary

Contains settings used by MiniCoverAliases.
Assembly
Cake.MiniCover.dll
Namespace
Cake.MiniCover.Settings
Base Types
  • DotNetCoreSettings
graph BT Type-->Base0["DotNetCoreSettings"] Type["MiniCoverSettings"] class Type type-node

Syntax

public sealed class MiniCoverSettings : DotNetCoreSettings

Constructors

Name Summary
MiniCoverSettings()

Properties

Name Value Summary
AssemblyExcludeGlobPatterns ISet<string>
Pattern to exclude assemblies
AssemblyIncludePatterns ISet<string>
Pattern to include assemblies
CoverageFileName string
Name of json coverage file
Coveralls CoverallsSettings
Settings for the COVERALLS report type
FailureThreshold float
Coverage percentage below which the build will fail
HitsFileName string
File name to store coverage hits in
MiniCoverWorkingDirectory DirectoryPath
The working directory for minicover (corresponds to the --workdir option)
NonFatalThreshold bool
If true, threshold is set for reporting only and will not fail the build
ReportPrefix string
The prefix for html and xml reports
ReportType ReportType
The type of report or reports to generate
SourcesExcludeGlobPatterns ISet<string>
Pattern to exclude source files
SourcesGlobPatterns ISet<string>
Pattern to include source files

Extension Methods

Name Value Summary
Dump<MiniCoverSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
GenerateReport(ReportType) MiniCoverSettings
Set the report type to generate
Requires the Cake.MiniCover addin
IsIn<MiniCoverSettings>(MiniCoverSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MiniCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<MiniCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<MiniCoverSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MiniCoverSettings>(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
WithAssembliesMatching(string) MiniCoverSettings
Instrument test assemblies matching the specified pattern
Requires the Cake.MiniCover addin
WithCoverageFile(string) MiniCoverSettings
Use the provided name for the internal coverage file
Requires the Cake.MiniCover addin
WithCoverallsSettings(Action<CoverallsSettings>) MiniCoverSettings
Set settings for coveralls report generation
Requires the Cake.MiniCover addin
WithCoverallsSettings(CoverallsSettings) MiniCoverSettings
Set settings for coveralls report generation
Requires the Cake.MiniCover addin
WithFatalThreshold() MiniCoverSettings
Fail the build if coverage is below the threshold. This is the default behavior.
Requires the Cake.MiniCover addin
WithHitsFile(string) MiniCoverSettings
Use the provided name for the hits file
Requires the Cake.MiniCover addin
WithMiniCoverWorkingDirectory(DirectoryPath) MiniCoverSettings
Set the --workdir for minicover
Requires the Cake.MiniCover addin
WithNonFatalThreshold() MiniCoverSettings
Do not fail the build if coverage is below the threshold
Requires the Cake.MiniCover addin
WithoutAssebliesMatching(string) MiniCoverSettings
Exclude from instrumentation all test assemblies matching the specified pattern
Requires the Cake.MiniCover addin
WithoutSourcesMatching(string) MiniCoverSettings
Exclude files matching the specified pattern from coverage results
Requires the Cake.MiniCover addin
WithReportPrefix(string) MiniCoverSettings
Use the specified prefix for report generation
Requires the Cake.MiniCover addin
WithSourcesMatching(string) MiniCoverSettings
Measure coverage on files matching the specified pattern
Requires the Cake.MiniCover addin
WithThreshold(float) MiniCoverSettings
Set the coverage percentage below which the build will fail
Requires the Cake.MiniCover addin