Expand description
Typed check-evaluation records.
Selection, configuration, applicability, evaluation coverage, content findings, and coverage gaps are independent dimensions. The types in this module are the single execution/result boundary for both CLI and embedded consumers.
Structs§
- Check
Evaluation - Final output-v10 record for one catalog check.
- Check
Output - Output evidence from one selected, enabled, applicable check.
- Coverage
Gap - A typed reason applicable work could not be evaluated.
- Coverage
GapCode - Stable machine code for an evaluation-coverage gap.
- Evaluation
Scope - A stable identifier for work that completed or could not be evaluated.
- Evaluation
Scope Code - Stable machine code for a unit of evaluated or missing work.
Enums§
- Applicability
- Whether a check applies to the supplied document and declarations.
- Check
Selection - Catalog-selection policy for
evaluate_checks. - Configuration
State - Whether configuration enabled the check.
- Evaluation
Error - Invalid catalog or check output supplied to
evaluate_checks. - Evaluation
State - How much applicable work was evaluated.
- Selection
State - Whether a check was selected for this invocation.
Constants§
- BUILTIN_
COVERAGE_ GAP_ CODES - Complete built-in coverage-gap vocabulary for consumers that need to inspect or allow-list animsmith’s catalog codes. Custom checks may use additional namespaced codes.
- BUILTIN_
EVALUATION_ SCOPE_ CODES - Complete built-in evaluation-scope vocabulary for consumers that need to inspect or allow-list animsmith’s catalog codes. Custom checks may use additional namespaced codes.
Functions§
- evaluate_
checks - Evaluate a full catalog into one record per check.
- lint_
requires_ failure - Apply the shared lint gate policy to validated check records.