Skip to main content

Module report

Module report 

Source
Expand description

Structured findings: severity, entity, rule, message.

A validation result must be machine-readable so a downstream consumer can act on it and a CI gate can fail on it.

§Internal split

  • finding.rs: severity and the individual finding.
  • detail.rs: typed detail behind a finding’s message.
  • path.rs: entity and attribute paths, and their total order.
  • summary.rs: counts and the assembled report.

Structs§

CatalogMemberDetail
A member of a catalog set that disagrees with the catalog’s template.
Finding
One thing a validator has to say about a file.
Report
Everything a validation run produced.
ReservedSetName
A set name using a reserved prefix the catalog does not define.
RuleDetail
One EXPRESS rule result.
Summary
Counts by severity, for a one-line verdict.

Enums§

BudgetExceeded
Which limit stopped an evaluation.
CatalogMismatch
How a set or member disagrees with its catalog template.
FindingDetail
Structured detail of a finding, when its check provides one.
NotEvaluated
Why a rule was not evaluated.
Path
Where in the file a finding applies.
RuleOutcome
What evaluating a rule on one instance, value or file concluded.
RuleScope
The declaration holding a rule.
Severity
How serious a finding is.