Before You File a Bug Report Please Confirm You Have Done The Following...

• I have tried restarting my IDE and the issue persists.
• I have updated to the latest version of the packages.
• I havesearched for related issues and found none that matched my issue.
• I haveread the FAQ and my problem is not listed.

Relevant Package

utils

Playground Link

https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBAbzgUQMoBlgDsYFUbAA2AznAL5wBmUEIcA5AAIwCeYApsQMZTBgwBaToWwwA9AFcCJegG4AUPPYAPSLDhcIWYvCgTC7OAF4UGUfiLEAdACV97AMJR2AQxjQrAd2AwAFhCkAEQguYgAKBHk4DWc3djDNHBUYAEpEKOi4ZxgJKCx0zMyASQATdhxgSmB2KDCsCDK0yMLCxJhkq2c1GAi4EE5iFwBzdlKALjgAIhUXcANJgBo4erLyFIUW8gzosgyyBYyyyhd9GAB5fmAtYgmAbQBdA+j+mBcJ5sySkJuClrLuXiXLQTej0J4tZyaED9LBlEogyG0GFwsHbTIQPw1CYwPTscE7fF9AbDTjvNHRGZzdgTSZnXzLCAAQkmaP2aNYHBBhBcLACMFRhW4vnYIDecAeewOZHWiiAA

Repro Code

import{ESLintUtils}from'@typescript-eslint/utils';exportconstrule=ESLintUtils.RuleCreator.withoutDocs({create(context){return{Identifier(node){context.report({messageId:"example", node});}}},defaultOptions:[],meta:{docs:{description:'',recommended:'recommended',other:true,},messages:{example:"Oh no!"},type:'layout',schema:[]},});

ESLint Config

n/a

tsconfig

n/a

Expected Result

Custom rules in community plugins shouldn't be tied into our types for what goes into a rule'smeta.docs. Plugins might define their own, potentially different documentation metadata & strategies.

Maybe we should makemeta.docs type...Record<string, unknown> for consumers? Or a type parameter onRuleCreator that defaults toRecord<string, unknown>?

Actual Result

• Known properties have types set to ours: e.g.meta.docs.recommended isRuleRecommended | undefined in 7.2.0
  • Afterfeat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364 (7.3.0), it'll beRuleRecommendation | RuleRecommendationAcrossConfigs<Options> | undefined
• Unknown properties cause a type error: e.g.meta.docs.other

Additional Info

See also:

• Change Request: Standardize documentation properties (e.g. allow configs to export description) eslint/eslint#17842: for a more general approach in ESLint core
• feat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364 (comment): noting thatfeat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364's expansion of themeta.docs.recommended property will be visible to users

Versions

💖