Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(utils): allow specifying additional rule meta.docs in RuleCreator#9025
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
feat(utils): allow specifying additional rule meta.docs in RuleCreator#9025
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Thanks for the PR,@JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently onhttps://opencollective.com/typescript-eslint. |
netlifybot commentedApr 29, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify site configuration. |
nx-cloudbot commentedApr 29, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
b1c92d4
intotypescript-eslint:v8Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
BREAKING CHANGE:
Changes the default allowed types on custom rule docs.
PR Checklist
Overview
Adds an optional
PluginDocs
type parameter toRuleCreator
that allows adding additional properties tometa.docs
. That allows us to moveextendsBaseRule
,recommended
, andrequiresTypeChecking
into our ownESLintPluginDocs
interface so that they're no longer exposed to consumers.Adds new
RuleModuleWithMetaDocs
andAnyRuleModuleWithMetaDocs
interfaces so that we can finally get rid of the?.
aftermeta.docs
in some of our internal tooling. AndRuleMetaDataDocs
no longer has anOptions
parameter, which simplifies some other types too.Adds back in
"layout"
tometa.type
as it actually is specified inhttps://eslint.org/docs/latest/extend/custom-rules.💖