docs: emphasize performance tradeoffs of typed linting #10730
Conversation
|
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. |
|
View your CI Pipeline Execution ↗ for commit a2cdccc.
☁️ Nx Cloud last updated this comment at |
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10730 +/- ##
=======================================
Coverage 87.26% 87.27%
=======================================
Files 450 450
Lines 15712 15719 +7
Branches 4600 4601 +1
=======================================
+ Hits 13711 13718 +7
Misses 1645 1645
Partials 356 356
Flags with carried forward coverage won't be shown. Click here to find out more. |
| This requires TypeScript to analyze your entire project instead of just the file being linted. | ||
|
|
||
| As a result, these rules are slower than traditional lint rules but are much more powerful. | ||
|
|
||
| To tap into TypeScript's additional powers, there are two small changes you need to make to your config file: |
There was a problem hiding this comment.
This sentence reads a little awkwardly now.... The "additional powers" is now kind of a dangling reference which used to point to the "...the awesome power...." in the formerly preceding sentence. The new "...much more powerful" doesn't set up quite the same parallelism. Any way to tweak this wording?
There was a problem hiding this comment.
Hmm yeah. I merged the first two groups together and switched the third to saying the more straightforward "enable type typed linting", WDYT?
PR Checklist
Overview
Adds almost no new content, instead emphasizing or reorganizing existing content:
/getting-started/typed-lintingto the actual typed linting FAQs, promoting the Performance heading to an h2💖