CoverletTool Class

Summary

A class for the coverlet tool
Assembly
Cake.Coverlet.dll
Namespace
Cake.Coverlet
Base Types
graph BT Type-->Base0["Tool<CoverletSettings>"] Type["CoverletTool"] class Type type-node

Syntax

public sealed class CoverletTool : Tool<CoverletSettings>

Constructors

Name Summary
CoverletTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the CoverletTool class.

Methods

Name Value Summary
GetAlternativeToolPaths(CoverletSettings) IEnumerable<FilePath>
Gets the alternative tool paths for the tool
GetToolExecutableNames() IEnumerable<string>
Gets the possible executable names
GetToolName() string
Gets the name of the tool.
Run(FilePath, FilePath, CoverletSettings) void
Runs the tool with the given test file, test project and settings

Extension Methods

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