Interface RuleMeta

interface RuleMeta {
    id: string;
    block: RuleBlock;
    severity: Severity;
    dimension: QualityDimension;
    description: string;
    defaultParams: Record<string, number>;
    references: string[];
}

Properties

id: string

Stable identifier, SCREAMING_SNAKE_CASE. Part of the public report contract.

block: RuleBlock

severity: Severity

Default severity; users can override it via config.

DAMA data quality dimension.

description: string

One-line description shown by mdsc rules.

defaultParams: Record<string, number>

Default thresholds. Every number a rule uses must live here so users can override it and every default must have a citation in references.

references: string[]

URLs to the real-world incident or literature justifying the rule and its thresholds.