AppliedRule

data class AppliedRule(val id: String, val description: String, val severity: Severity, val explanation: String, val ruleCount: Int, val violationCount: Int)(source)

One row of the active rule set, summarising a single rule id as enforced against the project.

Produced by RuleEngine.evaluate so the report can list which rules are applied - not only the ones that failed. Instances sharing an id are folded into one entry; see RuleEngine buildAppliedRules for the severity and count semantics.

Parameters

id

Stable kebab-case rule id (the public contract also used in SARIF and suppressions).

description

Human-readable rule description.

severity

Strictest effective severity across all instances of this id, overrides applied.

explanation

Plain-language "what and why" for the rule.

ruleCount

Number of configured rule instances folded under this id (usually 1).

violationCount

Violations attributed to this id after suppression - 0 means the rule passed.

Constructors

Link copied to clipboard
constructor(id: String, description: String, severity: Severity, explanation: String, ruleCount: Int, violationCount: Int)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val id: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard