KarmaSettings Class

Summary

Settings common across all Karma commands.
Assembly
Cake.Karma.dll
Namespace
Cake.Karma
Base Types
  • ToolSettings
Derived Types
graph BT Type-->Base0["ToolSettings"] Type["KarmaSettings"] class Type type-node Derived0["KarmaSharedSettings"]-->Type click Derived0 "/api/Cake.Karma/KarmaSharedSettings"

Syntax

public class KarmaSettings : ToolSettings

Constructors

Name Summary
KarmaSettings()

Fields

Name Constant Value Summary
DefaultLocalKarmaCli node_modules/karma-cli/bin/karma
The default Karma CLI file, if one is not specified during local run mode.
static

Properties

Name Value Summary
Colors bool
Use colors when reporting or printing logs. Defaults to false.
ConfigFile FilePath
The conf.js file to use.
LocalKarmaCli FilePath
Path to Karma CLI. Use this if you want to utilise a local Karma deployment, otherwise Global use is attempted.
LogLevel Nullable<KarmaLogLevel>
Level of logging.
NoColors bool
Do not use colors when reporting or printing logs. Defaults to false.
RunMode KarmaRunMode
Run karma locally or globally. Defaults to KarmaRunMode.Global.

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Evaluate further settings.

Extension Methods

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