Closed
Description
Before You File a Proposal Please Confirm You Have Done The Following...
- I have searched for related issues and found none that match my proposal.
- I have searched the current rule list and found no rules that match my proposal.
- I have read 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
import myNotDeprecatedFunction from "./other-file.ts";
/**
* @deprecated Use myNotDeprecatedFunction instead.
*/
export const myDeprecatedFunction = () => {
console.log("Hello world");
};Pass
import myNotDeprecatedFunction from "./other-file.ts";
/**
* @deprecated Use {@link myNotDeprecatedFunction} instead.
*/
export const myDeprecatedFunction = () => {
console.log("Hello world");
};Additional Info
TypeScript has a similar check, and I've created a similar issue for that too:
microsoft/TypeScript#49173