RuleMeta
Defined in: rule.ts:155
Properties
Section titled “Properties”category
Section titled “category”category:
string
Defined in: rule.ts:159
Category id this rule belongs to (defined by the rulepack).
defaultConfidence?
Section titled “defaultConfidence?”
optionaldefaultConfidence?:Confidence
Defined in: rule.ts:166
Certainty used by auto configs when a report does not provide its own.
defaultSeverity?
Section titled “defaultSeverity?”
optionaldefaultSeverity?:ActiveSeverity
Defined in: rule.ts:164
Severity applied when the rule is turned on without an explicit level.
docs:
object
Defined in: rule.ts:160
description
Section titled “description”description:
string
optionalurl?:string
fixable?
Section titled “fixable?”
optionalfixable?:"text"
Defined in: rule.ts:168
Present if the rule can emit an autofix.
messages?
Section titled “messages?”
optionalmessages?:Record<string,string>
Defined in: rule.ts:162
messageId → template string, {{key}} interpolated from report data.
name:
string
Defined in: rule.ts:157
Short name, unique within its rulepack (e.g. ‘corrective-antithesis’).
requires?
Section titled “requires?”
optionalrequires?:RuleRequirements
Defined in: rule.ts:170
Capabilities required before the engine can execute this rule honestly.