⚠️ This is pre-release documentation for v3. For stable docs, visit v2.
Skip to content

@tmlmt/cooklang-parser / Diagnostic

Interface: Diagnostic ​

A single diagnostic emitted during recipe parsing.

Properties ​

code ​

code: "COOKLANG_E0101" | "COOKLANG_E0102" | "COOKLANG_W0101" | "COOKLANG_E0201" | "COOKLANG_E0202" | "COOKLANG_E0203" | "COOKLANG_E0204" | "COOKLANG_W0201" | "COOKLANG_W0202" | "COOKLANG_E0301" | "COOKLANG_E0302" | "COOKLANG_W0301" | "COOKLANG_I0401" | "COOKLANG_W0401" | "COOKLANG_E9401" | "COOKLANG_E9402" | "COOKLANG_E9501" | "COOKLANG_E9502" | "COOKLANG_E9503" | "COOKLANG_E9504" | "COOKLANG_E9505" | "COOKLANG_E9601" | "COOKLANG_E9602" | "COOKLANG_E9603" | "COOKLANG_E9604" | "COOKLANG_W0601" | "COOKLANG_E9701" | "COOKLANG_W0701" | "COOKLANG_W0702" | "COOKLANG_E0701" | "COOKLANG_E0702"

Stable code identifying the problem (e.g. "COOKLANG_E0101").


docs? ​

optional docs?: string

Link to extended documentation, if available.


fix? ​

optional fix?: string

Actionable instructions on how to fix the problem, if available.


message ​

message: string

Human-readable description of what went wrong.


severity ​

severity: DiagnosticSeverity

Severity level (W codes are "warning"; E and I codes are "error").


span? ​

optional span?: DiagnosticSourceSpan

Location of the problem in the original recipe source.