Skip to content
1 min read · 259 words

Interface: Diagnostic

Defined in: src/batteries/dev_tools/types.ts:37

A diagnostic returned by the pipeline.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
column?numberOptional one-based start column; requires a valid line.RawDiagnostic.columnsrc/batteries/dev_tools/types.ts:30
endColumn?numberOptional one-based range end column.RawDiagnostic.endColumnsrc/batteries/dev_tools/types.ts:34
endLine?numberOptional one-based range end line.RawDiagnostic.endLinesrc/batteries/dev_tools/types.ts:32
engineIdstring | nullEngine id stamped by dispatch; null identifies diagnostics produced by the runtime.-src/batteries/dev_tools/types.ts:39
line?numberOptional one-based start line; invalid values are removed during normalization.RawDiagnostic.linesrc/batteries/dev_tools/types.ts:28
messagestringHuman-readable finding text; it remains useful even when invalid coordinates are removed.RawDiagnostic.messagesrc/batteries/dev_tools/types.ts:24
outOfScopebooleanTrue when the normalized file path is absent from the post-step workspace; always false for null paths.-src/batteries/dev_tools/types.ts:41
pathstring | nullWorkspace-relative file path; null identifies a workspace-level diagnostic with no single file.RawDiagnostic.pathsrc/batteries/dev_tools/types.ts:20
rule?stringOptional engine rule identifier.RawDiagnostic.rulesrc/batteries/dev_tools/types.ts:26
severitySeverityDiagnostic severity; only error makes a plan unsuccessful.RawDiagnostic.severitysrc/batteries/dev_tools/types.ts:22