You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When writing tsdoc strings, it's powerful to be able to reference types from an inline link tag.
It would however be great if the eslint plugin would mark these as used and avoid the @typescript-eslint/no-unused-vars rule reporting types that are only referenced from tsdoc comments as unused.
As an example, the following code
classMyClass{}/** This comment reference {@link MyClass} but it's still "never used" */constfoo=null;
yields
1:7 warning 'MyClass' is defined but never used @typescript-eslint/no-unused-vars
3:7 warning 'foo' is assigned a value but never used @typescript-eslint/no-unused-vars
I'm on vacation these days too and probably won't be looking into this for the next two weeks.
PR would probably be for the typescript-eslint project, not eslint-plugin-tsdoc, right
I'm not deeply familiar with the architecture of this project, but when I did similar work for the jsdoc plugin, it was valuable to implement this as a rule as it was responsible for parsing docs comments. It also seemed to make it easier for end-users to enable / disable and configure.
When writing tsdoc strings, it's powerful to be able to reference types from an inline link tag.
It would however be great if the eslint plugin would mark these as used and avoid the @typescript-eslint/no-unused-vars rule reporting types that are only referenced from tsdoc comments as unused.
As an example, the following code
yields
and I would love for that first line to go away.
This is already supported for plain (non inline tags) by the jsdoc plugin, through the use of the eslint SourceCode#markVariableAsUsed API, but it doesn't yet support inline tags and it would be great to have this supported in the
eslint-plugin-tsdoc
directly.I'd be interested in submitting a PR for this, if this is interesting for the maintainers.
The text was updated successfully, but these errors were encountered: