Skip to main content

Interface: PluginRuleDocs

Defined in: _internal/typed-rule.ts:78

Plugin-specific metadata extensions for meta.docs.

Remarksโ€‹

eslint-plugin/require-meta-docs-recommended expects meta.docs.recommended to be boolean. Preset membership is tracked separately via meta.docs.presets.

ruleId and ruleNumber are injected centrally by createTypedRule for cataloged prefer-* rules. Rule authors should not hand-author those fields in individual rule modules.

Propertiesโ€‹

configs?โ€‹

optional configs?:
  | "content"
  | "i18n"
  | "strict-mdx-upgrade"
  | readonly ("content" | "i18n" | "strict-mdx-upgrade")[];

Defined in: _internal/typed-rule.ts:79

presets?โ€‹

optional presets?:
  | "all"
  | "config"
  | "experimental"
  | "minimal"
  | "recommended"
  | "strict"
  | readonly ("all" | "config" | "experimental" | "minimal" | "recommended" | "strict")[];

Defined in: _internal/typed-rule.ts:80

optional recommended?: boolean;

Defined in: _internal/typed-rule.ts:81

requiresTypeChecking?โ€‹

optional requiresTypeChecking?: boolean;

Defined in: _internal/typed-rule.ts:82

ruleId?โ€‹

optional ruleId?: string;

Defined in: _internal/typed-rule.ts:83

ruleNumber?โ€‹

optional ruleNumber?: number;

Defined in: _internal/typed-rule.ts:84