docs: better rules table (filter rules by extension, etc.)

[Zamiell]

PR Checklist

• Addresses an existing open issue: fixes Docs: Formatting / Deprecated Rules are not clearly delineated in the rule list #7329
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

• This PR changes the docs in the way that Brad discusses in the linked issue.
• I got rid of all of the existing sidebar categories, since they do not make sense in the context of having a sortable table.
• I also created a "constants.ts" file to remove some existing DRY violations that I found in the repository.

[typescript-eslint]

Thanks for the PR, @Zamiell!

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	49ec745
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/652fe5c840e8a000086cd26c
😎 Deploy Preview	https://deploy-preview-7666--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 89 (🔴 down 6 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 49ec745. 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 19 targets

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

---

Sent with 💌 from NxCloud.

[JoshuaKGoldberg]

Some initial comments, what do you think?

[Josh-Cena]

Looks great to me, but will wait on @JoshuaKGoldberg

[JoshuaKGoldberg]

Looking great! I'm mostly happy - just suggesting some streamlining to the docs. WDYT? ✨

[Zamiell]

Looking great! I'm mostly happy - just suggesting some streamlining to the docs. WDYT?

All the feedback should be committed now.

[JoshuaKGoldberg]

🚀 thanks, this is looking great!

[JoshuaKGoldberg]

I just realized https://typescript-eslint.io/rules/#extension-rules is probably the only canonical link to an explanation of extension rules out there. So we probably don't want to get rid of the heading. But I've pestered you so much on this PR 😅 I'll just add it in, and if you @Josh-Cena / @Zamiell disagree we can always revert before the release on Monday.

[Zamiell]

do we really need a separate heading though? it is fairly self-explanatory what an extension rule is.
like, for example, consider class-methods-use-this.
if you go to the page for it, it says:

This rule extends the base eslint/class-methods-use-this rule. It adds support for ignoring override methods or methods on classes that implement an interface.

After reading this, i am not left wondering, "I have more questions about what an extension rule is, I wonder if there is a more formal definition out there in a dedicated section?"

[JoshuaKGoldberg]

I think folks need somewhere to hard-link to. It's similar to ESLint's issue for fixers vs suggestions: even if they're fairly straightforward for many, some folks coming in fresh have a hard time with them. I personally had a hard time both with fixers-vs-suggestions and what extension rules are.

[JoshuaKGoldberg]

Ooh and - pretty soon I think we'll be able to trim down the metadata list down to one sentence per item!

• Suggestions: can link to docs: explained rule fixers and suggestions eslint/eslint#17657 once it's in
• Formatting rules: https://eslint.style is coming soon

...which just leaves the deeper explanation on extension rules.

[JoshuaKGoldberg]

Whew, what a PR! Thanks again @Zamiell for iterating it on it with us. Shoutout @rubiesonthesky too!

@Josh-Cena I really liked your feedback and hope I didn't clobber over it in my eagerness to get the PR merged. :3

[Zamiell]

do we have a plan for mouseover-functionality-indication?

[JoshuaKGoldberg]

I personally have none. If you want to file & tackle that as a followup issue it could be nice. I'm also wondering if we'd want to rely on a more rich table library that has sorting, filtering, etc. built-in.