Interface: RuleDocsMetadata

Defined in: _internal/rule-creator.ts:14

Additional docs metadata used by this plugin's rule catalog and presets.

Hierarchy

View Summary

Extends

• RuleMetaDataDocs

Properties

catalogId?

readonly optional catalogId?: string

Defined in: _internal/rule-creator.ts:15

---

catalogIndex?

readonly optional catalogIndex?: number

Defined in: _internal/rule-creator.ts:16

---

deprecated?

readonly optional deprecated?: boolean

Defined in: _internal/rule-creator.ts:17

---

frozen?

readonly optional frozen?: boolean

Defined in: _internal/rule-creator.ts:18

Mark this rule as feature-frozen.

Overrides

TSESLint.RuleMetaDataDocs.frozen

---

recommended?

readonly optional recommended?: boolean

Defined in: _internal/rule-creator.ts:19

---

requiresTypeChecking?

readonly optional requiresTypeChecking?: boolean

Defined in: _internal/rule-creator.ts:20

---

ruleName?

readonly optional ruleName?: string

Defined in: _internal/rule-creator.ts:21

---

suggestion?

readonly optional suggestion?: boolean

Defined in: _internal/rule-creator.ts:22