ReportDescriptor

Defined in: rule.ts:100

What a rule passes to ctx.report. Give a location as either an explicit span or a set of tokens (with the sentence they belong to, so the engine can resolve their global offsets to a span). Give the message as a literal message, or a messageId into meta.messages with data for {{placeholder}} interpolation.

Properties

anchors?

optional anchors?: readonly LintAnchor[]

Defined in: rule.ts:112

---

assumptions?

optional assumptions?: readonly string[]

Defined in: rule.ts:114

---

confidence?

optional confidence?: Confidence

Defined in: rule.ts:110

Certainty for this occurrence; overrides the rule’s default confidence.

---

data?

optional data?: Record<string, string | number>

Defined in: rule.ts:106

---

evidence?

optional evidence?: readonly RuleEvidence[]

Defined in: rule.ts:111

---

fix?

optional fix?: TextFix

Defined in: rule.ts:107

---

magnitude?

optional magnitude?: LintMagnitude

Defined in: rule.ts:113

---

message?

optional message?: string

Defined in: rule.ts:105

---

messageId?

optional messageId?: string

Defined in: rule.ts:104

---

sentence?

optional sentence?: DepSentence

Defined in: rule.ts:103

---

span?

optional span?: object

Defined in: rule.ts:101

end

end: number

start

start: number

---

suggestion?

optional suggestion?: string

Defined in: rule.ts:108

---

tokens?

optional tokens?: DepToken[]

Defined in: rule.ts:102