Skip to main content

Type Alias: PluginRuleMetadata<MessageIds, Options>

type PluginRuleMetadata<MessageIds, Options> = Readonly<{
    docs: PluginRuleDocs & TSESLint.RuleMetaDataDocs;
    languages?: readonly PluginRuleLanguage[];
}> &
    TSESLint.RuleMetaData<MessageIds, PluginRuleDocs, Options>;

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

Rule metadata supported by this plugin's ESLint runtime.

Type Parametersโ€‹

MessageIdsโ€‹

MessageIds extends string

Optionsโ€‹

Options extends Readonly<UnknownArray>

Remarksโ€‹

ESLint 10 supports meta.languages, but the currently installed @typescript-eslint/utils metadata type does not expose it yet. Keeping the compatibility extension here preserves contextual typing for rule authors without casting rule definitions or weakening the public rule-module type.