checks/ack library

Classes

AckOutcome

Result of folding acknowledgements into a check run.

Enums

AckSubject

Applies .dialect/state.json acknowledgements to a CheckResult.

Properties

ackableRuleNames → List<String>

Every ack-able rule name, sorted — so the error text that lists them cannot drift from the map itself.

no setter

Functions

ackFingerprint(String ruleName, String? locale, String key, DialectProject project) → String?

Compute the ack fingerprint for ruleName on key/locale from the current project state, or null if it can't be resolved (unknown rule, missing key/translation). Used both to match acks at check-time and to write a fresh ack via dialect check --ack.

ackId(Issue issue) → String?

The <rule>:<locale>:<key> identifier for an issue, or null if the issue lacks the parts an ack needs (key is always required; a source-only issue uses the literal source locale slot).

applyAcks(CheckResult result, DialectProject project, StateStore state) → AckOutcome

Fold state into result for project. Suppresses issues whose ack still matches; surfaces (does not suppress) issues whose ack is stale, recording the stale ids.

isAckableRule(String ruleName) → bool

Whether ruleName supports acknowledgement at all.

isSourceHashed(String ruleName, {String? locale}) → bool

Whether ruleName fingerprints the source value (vs. the translation value) for an ack in locale. Only meaningful for ack-able rules; drives the sentence dialect check --ack prints back.