Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(eslint-plugin): add FAQ about JSDoc link usage with no-unused-vars #11259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 31, 2025
+16 −0
Merged

docs(eslint-plugin): add FAQ about JSDoc link usage with no-unused-vars #11259

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c3058b
docs(no-unused-vars): add FAQ about link usage in JSDoc
cseas May 30, 2025
612c10d
lint: prettier fix
cseas May 30, 2025
f5f46a7
chore: small typo
cseas May 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/eslint-plugin/docs/rules/no-unused-vars.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,19 @@ export interface Box {
</Tabs>

If you find yourself writing runtime values only for types, consider refactoring your code to declare types directly.

### Why are variables reported as unused despite being referenced by @link in JSDoc?

JSDoc references are not supported by typescript-eslint.
You can use a rule such as [`jsdoc/no-undefined-types`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md) to resolve variables as used in JSDoc comments.

```ts
import type { Box } from './Box';
// ~~~
// 'Box' is defined but never used.

/**
* @see {@link Box}
*/
export function getBox() {}
```
Loading