Skip to content

Interface: Diagnostic

Defined in: packages/providers/src/types.ts:167

One diagnostic from an aspect.

Properties

aspect

ts
aspect: string;

Defined in: packages/providers/src/types.ts:169

The aspect that produced it (e.g. modifier).


data?

ts
optional data?: object;

Defined in: packages/providers/src/types.ts:187

Optional structured payload for consumers. maskedName is the class token as it appears in the linted (possibly projected) source, so the language server can restore an embedded ${…} interpolation for display instead of the masked filler.

maskedName?

ts
optional maskedName?: string;

fix?

ts
optional fix?: DiagnosticFix;

Defined in: packages/providers/src/types.ts:181

A deterministic source edit, when the rule can be repaired safely.


message

ts
message: string;

Defined in: packages/providers/src/types.ts:173

A human-readable message.


record?

ts
optional record?: string;

Defined in: packages/providers/src/types.ts:175

The record it concerns, when applicable.


rule

ts
rule: string;

Defined in: packages/providers/src/types.ts:171

The rule name (e.g. unknown-modifier).


severity

ts
severity: Severity;

Defined in: packages/providers/src/types.ts:179

Severity (defaults to warning).


span?

ts
optional span?: SourceSpan;

Defined in: packages/providers/src/types.ts:177

The source span, when known (author-side comes from the index; usage-side from the usage).

Released under the MIT License