MarkdownlintNodeJsRunnerSettings Class

Summary

Settings for MarkdownlintNodeJsRunner .
Assembly
Cake.Markdownlint.dll
Namespace
Cake.Markdownlint.NodeJs
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["MarkdownlintNodeJsRunnerSettings"] class Type type-node

Syntax

public class MarkdownlintNodeJsRunnerSettings : ToolSettings

Constructors

Properties

Name Value Summary
ConfigFile FilePath
Gets or sets the path to the config file.
OutputFile FilePath
Gets or sets the path to the output file.
ThrowOnIssue bool
Gets or sets a value indicating whether an exception should be thrown if an issues was detected.

Methods

Name Value Summary
ForDirectory(DirectoryPath) MarkdownlintNodeJsRunnerSettings
Returns a new instance of the MarkdownlintNodeJsRunnerSettings class for linting a directory with files.
static
ForFile(FilePath) MarkdownlintNodeJsRunnerSettings
Returns a new instance of the MarkdownlintNodeJsRunnerSettings class for linting a single file.
static

Extension Methods

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