Context: We'd like to bolster the sections in our docs that explain whennot to use certain lint rules. Virtually all of our rules -even the exceptionally useful ones- have tradeoffs that can make them harder to use insome 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 tonot 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.

docs: enforce 'When Not To Use It' on all rules

7e5ad10

Copy link

Contributor

typescript-eslintbot commentedAug 10, 2023

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 commentedAug 10, 2023•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`ff3bba3`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6567298b4fad5500085adbdb
😎 Deploy Preview	https://deploy-preview-7447--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 11 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.

JoshuaKGoldberg mentioned this pull request

Aug 10, 2023

Repo: Enforce that all rules have a "When Not To Use It" docs section?#7257

Closed

Copy link

nx-cloudbot commentedAug 10, 2023•
edited
Loading

☁️ Nx Cloud Report

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

📂 See all runs for this branch

✅ Successfully ran 37 targets

Sent with 💌 fromNxCloud.

bradzacher reviewed

Aug 10, 2023

View reviewed changes

packages/eslint-plugin/docs/rules/ban-types.md OutdatedShow resolvedHide resolved

packages/eslint-plugin/docs/rules/no-duplicate-enum-values.md OutdatedShow resolvedHide resolved

packages/eslint-plugin/docs/rules/no-duplicate-type-constituents.md OutdatedShow resolvedHide resolved

packages/eslint-plugin/docs/rules/no-extra-non-null-assertion.md OutdatedShow resolvedHide resolved

Responded to immediate feedback

81d6b3b

JoshuaKGoldberg changed the title~~docs: enforce 'When Not To Use It' on all rules~~docs: add 'When Not To Use It' or an intentional omission notice on all rules

Nov 13, 2023

Filled them all in and updated test

cb4db89

JoshuaKGoldberg force-pushed thedocs-when-not-to-use-it branch from389a697 tocb4db89Compare

November 13, 2023 21:47

JoshuaKGoldberg added3 commits

November 13, 2023 16:49

Merge branch 'main'

c8706fd

Remove .nx shenanigans

332e0b7

Merge branch 'main' into docs-when-not-to-use-it