Adds the suggested"which comes with performance tradeoffs" note to the auto-added cards on top of rules pages
Moves FAQs from/getting-started/typed-linting to the actual typed linting FAQs, promoting thePerformance heading to an h2

💖

docs: emphasize performance tradeoffs of typed linting

c82f4ad

Copy link

Contributor

typescript-eslintbot commentedJan 28, 2025

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 commentedJan 28, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`a2cdccc`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/67a0dcf78af624000833b717
😎 Deploy Preview	https://deploy-preview-10730--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 93 (🔴 down 5 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.

Copy link

nx-cloudbot commentedJan 28, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commita2cdccc.

Command	Status	Duration	Result
`nx test utils`	✅ Succeeded	<1s	View ↗
`nx test visitor-keys`	✅ Succeeded	<1s	View ↗
`nx run types:build`	✅ Succeeded	<1s	View ↗
`nx test type-utils`	✅ Succeeded	<1s	View ↗
`nx run-many --target=build --exclude website --...`	✅ Succeeded	4s	View ↗
`nx test utils --coverage=false`	✅ Succeeded	<1s	View ↗
`nx test typescript-eslint`	✅ Succeeded	<1s	View ↗
`nx run-many --target=clean`	✅ Succeeded	13s	View ↗
`Additional runs (24)`	✅ Succeeded	...	View ↗

☁️Nx Cloud last updated this comment at2025-02-03 15:28:53 UTC

JoshuaKGoldberg requested review fromnzakas anda team

January 29, 2025 20:39

nzakas reviewed

Jan 30, 2025

View reviewed changes

docs/getting-started/Typed_Linting.mdx OutdatedShow resolvedHide resolved

packages/website/src/theme/MDXComponents/RuleAttributes.tsxShow resolvedHide resolved

JoshuaKGoldbergand others added3 commits

January 31, 2025 08:35

Apply suggestions from code review

b03b3ad

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

Tweaking the lines

f35e091

Tweaking the lines 2

b8f316c

Copy link

codecovbot commentedJan 31, 2025•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.27%. Comparing base(94e8098) to head(a2cdccc).
Report is 29 commits behind head on main.

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

Flag	Coverage Δ
unittest	`87.27% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

see 5 files with indirect coverage changes

kirkwaiblinger reviewed

Feb 2, 2025

View reviewed changes

docs/getting-started/Typed_Linting.mdx Outdated

		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:

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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?