Interface FileResult<K>

A finding of a check kind at a file (and line) of the package.

interface FileResult<K extends string> {
    certainty: LintingResultCertainty;
    file: string;
    involvedId: NodeId | NodeId[] | undefined;
    kind: K;
    loc: readonly [Line, Column, Line, Column, string | undefined];
    message: string;
    quickFix?: LintQuickFix[];
}

Type Parameters

K extends string

Hierarchy (View Summary)

CmdCheckResult
- FileResult

Index

Properties

certainty file involvedId kind loc message quickFix?

Properties

`Readonly`certainty

certainty: LintingResultCertainty

The certainty of the linting result.

`Readonly`file

file: string

`Readonly`involvedId

involvedId: NodeId | NodeId[] | undefined

The node ID or IDs involved in this linting result, if applicable.

`Readonly`kind

kind: K

`Readonly`loc

loc: readonly [Line, Column, Line, Column, string | undefined]

The source location where this linting result occurs

`Readonly`message

message: string

`Optional` `Readonly`quickFix

quickFix?: LintQuickFix[]

If available, what to do to fix the linting result.