Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

YamlLintFinding

OfficeIMO.Yaml

Namespace
OfficeIMO.Yaml
Assembly
OfficeIMO.Yaml
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

One problem YamlLinter found, with where it is and, when it can be repaired safely, how.

Inheritance

  • object
  • YamlLintFinding

Usage

Explore 3 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.

Returned or exposed by 3

Methods

public override string ToString() #

Formats the finding as line:column severity message (rule), the layout yamllint prints.

Returns

string

Properties

public string RuleId { get; } #

Gets the rule that reported the finding, one of the YamlLintRules ids.

public OfficeDiagnosticSeverity Severity { get; } #

Gets the severity configured for the rule.

public YamlPosition Position { get; } #

Gets where the problem is in the linted text.

public int Line { get; } #

Gets the one-based line of YamlLintFinding.Position.

public int Column { get; } #

Gets the one-based column of YamlLintFinding.Position, in UTF-16 code units.

public string Message { get; } #

Gets a sentence describing the problem.

public YamlLintFix? Fix { get; } #

Gets the text edit that repairs the problem without changing any value, or null when the rule has no safe repair for it. YamlLinter.Fix applies these edits.