Interface Diagnostic

One finding about the input, with a stable code that tools and tests can match on.

interface Diagnostic {
    Code: string;
    FixHint: string | null;
    Message: string;
    Severity: DiagnosticSeverity;
    Span: Span;
}

Index

Properties

Code FixHint Message Severity Span

Properties

`Readonly`Code

Code: string

A stable identifier, such as MJQ_UNFILTERED_VALUE. Codes never change meaning.

`Readonly`FixHint

FixHint: string | null

How to fix it, or null when there is nothing specific to suggest.

`Readonly`Message

Message: string

What is wrong, in a sentence a query author can act on.

`Readonly`Severity

Severity: DiagnosticSeverity

`Readonly`Span

Span: Span

The part of the input the finding is about.