This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Markdownlint.

Summary

Settings for Cake.Markdownlint.NodeJs.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

Name	Summary
MarkdownlintNodeJsRunnerSettings(DirectoryPath)	Initializes a new instance of the `MarkdownlintNodeJsRunnerSettings` class.
MarkdownlintNodeJsRunnerSettings(FilePath)	Initializes a new instance of the `MarkdownlintNodeJsRunnerSettings` class.

Properties

Name	Value	Summary
ConfigFile	FilePath	Gets or sets the path to the config file.
JsonFormat	bool	Gets or sets a value indicating whether the log file is written in json format or not.
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