docs: add 'When Not To Use It' or an intentional omission notice on all rules #7447
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
bradzacher
reviewed
Aug 10, 2023
packages/eslint-plugin/docs/rules/no-duplicate-type-constituents.md
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/docs/rules/no-extra-non-null-assertion.md
Outdated
Show resolved
Hide resolved
389a697 to
cb4db89
Compare
Faithfinder
reviewed
Nov 13, 2023
packages/eslint-plugin/docs/rules/restrict-template-expressions.md
Outdated
Show resolved
Hide resolved
bradzacher
approved these changes
Nov 29, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Overview
Context: We'd like to bolster the sections in our docs that explain when not to use certain lint rules. Virtually all of our rules -even the exceptionally useful ones- have tradeoffs that can make them harder to use in some projects. We'd love to know what those tradeoffs are so we can document them!
Posting as a reference draft for #7257.Marking as ready for review. I'd love any and all feedback on this: what reasons have you seen to not use specific lint rules? Please do comment them here, in the file for the corresponding lint rule! (or DM/email me somewhere if you want to send private feedback)I can't promise we'll agree with all reasons 😄 but at the very least they're good for us to know. And oftentimes "our project wasn't architected in a way to allow this code pattern" is a good reason for us to mention.