JekyllVersionSettings Class

Summary

Contains settings used by Cake.Jekyll.Commands.Version.JekyllVersionCommand.
Assembly
Cake.Jekyll.dll
Namespace
Cake.Jekyll.Commands.Version
Base Types
graph BT Type-->Base0["JekyllSettings"] click Base0 "/api/Cake.Jekyll/JekyllSettings" Base0-->Base1["ToolSettings"] Type["JekyllVersionSettings"] class Type type-node

Syntax

public class JekyllVersionSettings : JekyllSettings

Constructors

Name Summary
JekyllVersionSettings() Initializes a new instance of the JekyllVersionCommand class.

Properties

Name Value Summary
Command string
Gets the command which should be run.
Inherited from JekyllSettings
DoNotUseBundler Nullable<bool>
Gets or sets if Bundler should *not* be used to execute Jekyll (defaults to ). `jekyll` instead of `bundle exec`...
Inherited from JekyllSettings

Methods

Name Value Summary
ApplyOption(ProcessArgumentBuilder, Nullable<JekyllLogLevel>) void
Apply option for the Jekyll Log Level
Inherited from JekyllSettings
ApplyOption(ProcessArgumentBuilder, string, Nullable<bool>) void
Apply option from a nullable boolean value
Inherited from JekyllSettings
ApplyOption(ProcessArgumentBuilder, string, Nullable<int>) void
Apply option from a nullable int value
Inherited from JekyllSettings
ApplyOption(ProcessArgumentBuilder, string, Nullable<TimeSpan>) void
Apply option from one or more string values
Inherited from JekyllSettings
ApplyOption(ProcessArgumentBuilder, string, OneOrMoreDirectoryPaths) void
Apply option from directory path(s)
Inherited from JekyllSettings
ApplyOption(ProcessArgumentBuilder, string, OneOrMoreFilePaths) void
Apply option from file path(s)
Inherited from JekyllSettings
ApplyOption(ProcessArgumentBuilder, string, OneOrMoreStrings) void
Apply option from one or more string values
Inherited from JekyllSettings
ApplyOption(ProcessArgumentBuilder, string, string) void
Apply option from a string value
Inherited from JekyllSettings
ApplyValue(ProcessArgumentBuilder, string) void
Apply option from a string value
Inherited from JekyllSettings
EvaluateCore(ProcessArgumentBuilder) void
Evaluates the settings and writes them to args.
Inherited from JekyllSettings

Extension Methods

Name Value Summary
DoNotUseBundler(Nullable<bool>) JekyllVersionSettings
Specifies if Bundler should not be used to execute Jekyll. `jekyll` instead of `bundle exec`...
Requires the Cake.Jekyll addin
Dump<JekyllVersionSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<JekyllVersionSettings>(JekyllVersionSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<JekyllVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<JekyllVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
SetWorkingDirectory(DirectoryPath) JekyllVersionSettings
Sets the working directory which should be used to run the Jekyll command.
Requires the Cake.Jekyll addin
ThrowIfNull<JekyllVersionSettings>(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<JekyllVersionSettings>(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