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 Proposal Please Confirm You Have Done The Following...
- I havesearched for related issues and found none that match my proposal.
- I have searched thecurrent rule list and found no rules that match my proposal.
- I haveread the FAQ and my problem is not listed.
My proposal is suitable for this project
- I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).
Link to the rule's documentation
https://typescript-eslint.io/rules/no-unused-vars
Description
I propose that the rule should not give a warning if the imported type is being referenced in a TSDoc. It's very useful, specially in combination with@deprecated Use {@link myOtherType} instead.
.
Fail
importmyNotDeprecatedFunctionfrom"./other-file.ts";/** *@deprecated Use myNotDeprecatedFunction instead. */exportconstmyDeprecatedFunction=()=>{console.log("Hello world");};
Pass
importmyNotDeprecatedFunctionfrom"./other-file.ts";/** *@deprecated Use {@link myNotDeprecatedFunction} instead. */exportconstmyDeprecatedFunction=()=>{console.log("Hello world");};
Additional Info
TypeScript has a similar check, and I've created a similar issue for that too:
microsoft/TypeScript#49173