MSpecSettings Class

Summary

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

Syntax

public sealed class MSpecSettings : ToolSettings

Properties

Name Value Summary
Appveyor bool
Gets or sets a value indicating whether to enable reporting for AppVeyor CI integration(also auto - detected)
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
Exclude string
Gets or sets Exclude specifications in contexts with these comma delimited tags. Ex. - x "foo,bar,foo_bar"
Filters FilePath
Gets or sets the path to the filter file specifying contexts to execute(full type name, one per line). Takes precedence over tags
HtmlReport bool
Gets or sets a value indicating whether an HTML report should be generated.
Include string
Gets or sets Executes all specifications in contexts with these comma delimited tags. Ex. - i "foo,bar,foo_bar"
NoAppveyor bool
Gets or sets a value indicating whether disable AppVeyor autodetection
NoColor bool
Gets or sets a value indicating whether to suppress colored console output
NoTeamCity bool
Gets or sets a value indicating whether to disable TeamCity autodetection
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
Inherited from ToolSettings
OutputDirectory DirectoryPath
Gets or sets output directory for reports
Progress bool
Gets or sets a value indicating whether to print dotted progress output
ReportName string
Gets or sets the name that should be used for the HTML and XML reports.
Silent bool
Gets or sets a value indicating whether to suppress progress output(print fatal errors, failures and summary)
TeamCity bool
Gets or sets a value indicating whether reporting for TeamCity CI integration(also auto - detected)
TimeInfo bool
Gets or sets a value indicating whether to show time-related information in HTML output
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
UseX86 bool
Gets or sets a value indicating whether to use X86
Wait bool
Gets or sets a value indicating whether to wait 15 seconds for debugger to be attached
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
XmlReport bool
Gets or sets a value indicating whether an XML report should be generated.

Extension Methods

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