feat(utils): allow specifying additional rule meta.docs in RuleCreator

[JoshuaKGoldberg]

BREAKING CHANGE:

Changes the default allowed types on custom rule docs.

PR Checklist

• Addresses an existing open issue: fixes Bug: RuleCreator leaks internal meta.docs, meta.type types #8695
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

Adds an optional PluginDocs type parameter to RuleCreator that allows adding additional properties to meta.docs. That allows us to move extendsBaseRule, recommended, and requiresTypeChecking into our own ESLintPluginDocs interface so that they're no longer exposed to consumers.

Adds new RuleModuleWithMetaDocs and AnyRuleModuleWithMetaDocs interfaces so that we can finally get rid of the ?. after meta.docs in some of our internal tooling. And RuleMetaDataDocs no longer has an Options parameter, which simplifies some other types too.

Adds back in "layout" to meta.type as it actually is specified in https://eslint.org/docs/latest/extend/custom-rules.

💖

[typescript-eslint]

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.

[netlify]

✅ Deploy Preview for typescript-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 your Netlify site configuration.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b60b726. 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

• nx test eslint-plugin --coverage=false
• nx test eslint-plugin
• nx test typescript-eslint --coverage=false
• nx run types:build
• nx test typescript-estree --coverage=false
• nx run repo-tools:postinstall-script
• nx test type-utils --coverage=false
• nx test visitor-keys --coverage=false
• nx test utils --coverage=false
• nx test scope-manager --coverage=false
• nx test repo-tools --coverage=false
• nx test rule-schema-to-typescript-types --coverage=false
• nx test parser --coverage=false
• nx run-many --target=build --parallel --exclude=website --exclude=website-eslint
• nx test eslint-plugin-internal --coverage=false
• nx test ast-spec --coverage=false
• nx run-many --target=lint --parallel --exclude eslint-plugin
• nx test typescript-estree
• nx test visitor-keys
• nx test utils
• nx test type-utils
• nx test scope-manager
• nx test typescript-eslint
• nx test rule-schema-to-typescript-types
• nx test parser
• nx test repo-tools
• nx test eslint-plugin-internal
• nx run integration-tests:test
• nx run-many --target=typecheck --parallel
• nx test ast-spec
• nx run repo-tools:generate-configs

---

Sent with 💌 from NxCloud.

[bradzacher]