YamlLintOptions
OfficeIMO.Yaml
The rules YamlLinter checks and how. The defaults report what is likely a mistake or reads differently in other tools, and leave matters of taste (document markers, empty values, quoting, key order) off.
Inheritance
- object
- YamlLintOptions
Usage
Explore 2 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters 2
- Method YamlLinter.Fix
- Method YamlLinter.Lint
Constructors
Methods
public YamlLintRuleOptions? GetRule(string ruleId) #Returns the rule with an id from YamlLintRules, or null for an unknown id.
Parameters
- ruleId string
Returns
YamlLintRuleOptions?Inherited Methods
Properties
public YamlLintIndentationOptions Indentation { get; } #Gets the YamlLintRules.Indentation rule. On by default.
public YamlLintRuleOptions TrailingSpaces { get; } #Gets the YamlLintRules.TrailingSpaces rule. On by default.
public YamlLintLineLengthOptions LineLength { get; } #Gets the YamlLintRules.LineLength rule. On by default, at 120 characters.
public YamlLintTruthyOptions Truthy { get; } #Gets the YamlLintRules.Truthy rule. On by default.
public YamlLintRuleOptions KeyDuplicates { get; } #Gets the YamlLintRules.KeyDuplicates rule. On by default, as an error.
public YamlLintDocumentStartOptions DocumentStart { get; } #Gets the YamlLintRules.DocumentStart rule. Off by default.
public YamlLintEmptyValuesOptions EmptyValues { get; } #Gets the YamlLintRules.EmptyValues rule. Off by default.
public YamlLintCommentsOptions Comments { get; } #Gets the YamlLintRules.Comments rule. On by default.
public YamlLintOctalValuesOptions OctalValues { get; } #Gets the YamlLintRules.OctalValues rule. On by default, for implicit octals only.
public YamlLintRuleOptions Tabs { get; } #Gets the YamlLintRules.Tabs rule. On by default.
public YamlLintRuleOptions NewLineAtEndOfFile { get; } #Gets the YamlLintRules.NewLineAtEndOfFile rule. On by default.
public YamlLintEmptyLinesOptions EmptyLines { get; } #Gets the YamlLintRules.EmptyLines rule. On by default.
public YamlLintQuotedStringsOptions QuotedStrings { get; } #Gets the YamlLintRules.QuotedStrings rule. Off by default.
public YamlLintRuleOptions KeyOrdering { get; } #Gets the YamlLintRules.KeyOrdering rule. Off by default.
public IReadOnlyList<YamlLintRuleOptions> Rules { get; } #Gets every configurable rule, in the order findings of one line are reported.
public YamlLoadOptions? LoadOptions { get; set; } #Gets or sets how the text is loaded, or null (the default) for a lenient load that admits duplicate keys so YamlLintRules.KeyDuplicates can report them.