Skip to content

Commit 42d001f

Browse files
committed
Merge remote-tracking branch 'origin/main' into migrate-to-pnpm
2 parents 4649727 + e493317 commit 42d001f

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

docs/getting-started/Typed_Linting.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ module.exports = {
8282
In more detail:
8383

8484
- `plugin:@typescript-eslint/recommended-type-checked` is a [shared configuration](../users/Shared_Configurations.mdx). It contains recommended rules that additionally require type information.
85-
- `parserOptions.projectService: true` indicates to ask TypeScript's type checking service for each source file's type information (see [Parser > `projectService`](../packages/Parser.mdx#projectService)).
85+
- `parserOptions.projectService: true` indicates to ask TypeScript's type checking service for each source file's type information (see [Parser > `projectService`](../packages/Parser.mdx#projectservice)).
8686
- `parserOptions.tsconfigRootDir` tells our parser the absolute path of your project's root directory (see [Parser > `tsconfigRootDir`](../packages/Parser.mdx#tsconfigrootdir)).
8787

8888
</TabItem>
@@ -163,5 +163,5 @@ If you're having problems with typed linting, please see our [Troubleshooting FA
163163

164164
For details on the parser options that enable typed linting, see:
165165

166-
- [Parser > `projectService`](../packages/Parser.mdx#projectService): our recommended option, with settings to customize TypeScript project information
167-
- [Parser > `project`](../packages/Parser.mdx#projectService): an older option that can be used as an alternative
166+
- [Parser > `projectService`](../packages/Parser.mdx#projectservice): our recommended option, with settings to customize TypeScript project information
167+
- [Parser > `project`](../packages/Parser.mdx#project): an older option that can be used as an alternative

docs/packages/Parser.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ If this setting is specified, you must only lint files that are included in the
282282
}
283283
```
284284

285-
For an option that allows linting files outside of your TSConfig file(s), see [`projectService`](#projectService).
285+
For an option that allows linting files outside of your TSConfig file(s), see [`projectService`](#projectservice).
286286

287287
<HiddenHeading id="experimental_useprojectservice" />
288288

packages/eslint-plugin/docs/rules/no-unused-vars.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,3 +118,19 @@ export interface Box {
118118
</Tabs>
119119

120120
If you find yourself writing runtime values only for types, consider refactoring your code to declare types directly.
121+
122+
### Why are variables reported as unused despite being referenced by @link in JSDoc?
123+
124+
JSDoc references are not supported by typescript-eslint.
125+
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.
126+
127+
```ts
128+
import type { Box } from './Box';
129+
// ~~~
130+
// 'Box' is defined but never used.
131+
132+
/**
133+
* @see {@link Box}
134+
*/
135+
export function getBox() {}
136+
```

0 commit comments

Comments
 (0)