Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
Closed
Description
Before You File a Documentation Request Please Confirm You Have Done The Following...
- I have looked for existingopen or closed documentation requests that match my proposal.
- I haveread the FAQ and my problem is not listed.
Suggested Changes
Right now, there is very little mention of how type-aware linting affects performance. If you go to any type-aware rule page, like this:
https://typescript-eslint.io/rules/await-thenable
We see this:
This rule requirestype information to run.
But there is no mention of any performance issues.
If you click through to the typed linting docs, the only real mention is way down the page:
https://typescript-eslint.io/getting-started/typed-linting/#how-is-performance
I'd really like to see:
- The note on each rule page updated to include "This rule requirestype information to run, which comes with performance tradeoffs."
- An "important" block at the top ofhttps://typescript-eslint.io/getting-started/typed-linting/ noting that there is a performance hit for type-aware rules and then linking to the section with more details.
Affected URL(s)
https://typescript-eslint.io/getting-started/typed-linting/
And each type-aware rule page.
Additional Info
No response