RuleAbout
Metadata about a rule, as used to define the rule.
Properties
Section titled “Properties”defaultOptions?
Section titled “defaultOptions?”
optionaldefaultOptions:RuleOptionsRaw
Options the rule should run with unless overridden per-rule by users. These take precedence over any options users set globally for all rules.
description
Section titled “description”description:
string
Single sentence description of the rule.
explanation
Section titled “explanation”explanation:
string[]
Additional sentences describing the rule.
name:
string
kebab-case name of the rule.