ScriptConventions Class

Summary

The script conventions used by Cake.
Namespace
Cake.Core.Scripting
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IScriptConventions"] click Interface0 "/api/Cake.Core.Scripting/IScriptConventions" Type["ScriptConventions"] class Type type-node

Syntax

public sealed class ScriptConventions : IScriptConventions

Constructors

Name Summary
ScriptConventions(IFileSystem, IAssemblyLoader, ICakeRuntime, IReferenceAssemblyResolver) Initializes a new instance of the ScriptConventions class.

Methods

Name Value Summary
GetDefaultAssemblies(DirectoryPath) IReadOnlyList<Assembly>
Gets the default assemblies.
GetDefaultDefines() IReadOnlyList<string>
Gets the default defines.
GetDefaultNamespaces() IReadOnlyList<string>
Gets the default namespaces.

Extension Methods

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