Skip to main content

Module diagnostics

Module diagnostics 

Source
Expand description

Unified diagnostic types for all issue-reporting commands.

Any command that finds “problems in files” — broken references, stale docs, missing examples, security findings, lint violations, rule matches — should converge on these types.

Structs§

ArchivedIssue
An archived Issue
ArchivedRelatedLocation
An archived RelatedLocation
DiagnosticsReport
Report containing diagnostic issues from one or more checks.
Issue
A single diagnostic issue found during a check.
IssueResolver
The resolver for an archived Issue
RelatedLocation
A secondary location related to an issue (e.g., the other file in a circular dep).
RelatedLocationResolver
The resolver for an archived RelatedLocation
ToolFailure
A record of a tool that failed to run or produce valid output.

Enums§

ArchivedSeverity
An archived Severity
Severity
Severity level for a diagnostic issue.
SeverityResolver
The resolver for an archived Severity