Toolmark

Appearance

toolmark-monorepo / @toolmark/lint / Finding

Interface: Finding ​

Defined in: packages/lint/src/types.ts:7

One lint finding: a rule violation, or an informational note from a Judge. tool and page are omitted when a finding is not scoped to one (e.g. judge-failed).

Properties ​

message ​

message: string

Defined in: packages/lint/src/types.ts:17

Human-readable explanation.

page? ​

optional page?: string

Defined in: packages/lint/src/types.ts:15

The page the finding was found on.

rule ​

rule: string

Defined in: packages/lint/src/types.ts:9

Rule id, e.g. "name-format", or "judge/description-quality" for judge findings.

score? ​

optional score?: number

Defined in: packages/lint/src/types.ts:19

A judge's numeric score backing the finding (e.g. judge/description-quality).

severity ​

severity: "error" | "warn"

Defined in: packages/lint/src/types.ts:11

"error" fails the CLI (exit 1); "warn" never does.

tool? ​

optional tool?: string

Defined in: packages/lint/src/types.ts:13

Full name of the offending tool, when the finding is scoped to one.