docs: better rules table (filter rules by extension, etc.) #7666
Conversation
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
All the feedback should be committed now. |
|
|
||
| ## Extension Rules |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?"
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
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 |
|
do we have a plan for mouseover-functionality-indication? |
|
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. |
PR Checklist
Overview