Adds an optionalPluginDocs 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 newRuleModuleWithMetaDocs 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.

💖

feat(utils): [RuleCreator] require specifying additional rule meta.docs

c3cb5cc

JoshuaKGoldberg added this to the8.0.0 milestone

Apr 29, 2024

Copy link

Contributor

typescript-eslintbot commentedApr 29, 2024

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 on https://opencollective.com/typescript-eslint.

Copy link

netlifybot commentedApr 29, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`b60b726`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/663be9aa205b920008cc753e
😎 Deploy Preview	https://deploy-preview-9025--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 98 (🟢 up 2 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify site configuration.

Copy link

nx-cloudbot commentedApr 29, 2024•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commitb60b726. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 31 targets

Sent with 💌 fromNxCloud.

JoshuaKGoldberg changed the title~~feat(utils): [RuleCreator] require specifying additional rule meta.docs~~feat(utils): require specifying additional rule meta.docs in RuleCreator

Apr 29, 2024

test fix

024b053

JoshuaKGoldberg changed the title~~feat(utils): require specifying additional rule meta.docs in RuleCreator~~feat(utils): allow specifying additional rule meta.docs in RuleCreator

Apr 29, 2024