MiniCoverSettingsExtensions Class

Summary

Contains extensions for MiniCoverSettings.
Assembly
Cake.MiniCover.dll
Namespace
Cake.MiniCover.Settings
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["MiniCoverSettingsExtensions"] class Type type-node

Syntax

public static class MiniCoverSettingsExtensions

Methods

Name Value Summary
GenerateReport(MiniCoverSettings, ReportType) MiniCoverSettings
Set the report type to generate
static
WithAssembliesMatching(MiniCoverSettings, string) MiniCoverSettings
Instrument test assemblies matching the specified pattern
static
WithCoverageFile(MiniCoverSettings, string) MiniCoverSettings
Use the provided name for the internal coverage file
static
WithCoverallsSettings(MiniCoverSettings, Action<CoverallsSettings>) MiniCoverSettings
Set settings for coveralls report generation
static
WithCoverallsSettings(MiniCoverSettings, CoverallsSettings) MiniCoverSettings
Set settings for coveralls report generation
static
WithFatalThreshold(MiniCoverSettings) MiniCoverSettings
Fail the build if coverage is below the threshold. This is the default behavior.
static
WithHitsFile(MiniCoverSettings, string) MiniCoverSettings
Use the provided name for the hits file
static
WithMiniCoverWorkingDirectory(MiniCoverSettings, DirectoryPath) MiniCoverSettings
Set the --workdir for minicover
static
WithNonFatalThreshold(MiniCoverSettings) MiniCoverSettings
Do not fail the build if coverage is below the threshold
static
WithoutAssebliesMatching(MiniCoverSettings, string) MiniCoverSettings
Exclude from instrumentation all test assemblies matching the specified pattern
static
WithoutSourcesMatching(MiniCoverSettings, string) MiniCoverSettings
Exclude files matching the specified pattern from coverage results
static
WithReportPrefix(MiniCoverSettings, string) MiniCoverSettings
Use the specified prefix for report generation
static
WithSourcesMatching(MiniCoverSettings, string) MiniCoverSettings
Measure coverage on files matching the specified pattern
static
WithThreshold(MiniCoverSettings, float) MiniCoverSettings
Set the coverage percentage below which the build will fail
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin