Skip to content

Commit 0eb08e8

Browse files
db295dorb-legitautofix-ci[bot]
authored
fix(noUnusedImports): parse also linkcode, and not only link (#8088)
Co-authored-by: D'or Banoun <dor@legitsecurity.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 7fdcec8 commit 0eb08e8

6 files changed

Lines changed: 477 additions & 2 deletions

File tree

‎.changeset/forty-hornets-burn.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
"@biomejs/biome": patch
3+
---
4+
5+
Fixed [#7876](https://github.com/biomejs/biome/issues/7876): The [`noUnusedImports`](https://biomejs.dev/linter/rules/no-unused-imports/) rule now ignores imports that are used by @linkcode and @linkplain (previously supported @link and @see).
6+
7+
The following code will no longer be a false positive:
8+
9+
```js
10+
import type { a } from "a"
11+
12+
/**
13+
* {@linkcode a}
14+
*/
15+
function func() {}
16+
```

‎crates/biome_js_analyze/src/lint/correctness/no_unused_imports.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,9 @@ fn load_jsdoc_types_from_node(model: &mut JsDocTypeModel, node: &SyntaxNode<JsLa
164164
});
165165
}
166166

167-
static JSDOC_INLINE_TAG_REGEX: LazyLock<Regex> =
168-
LazyLock::new(|| Regex::new(r"\{@(link|see)\s*([^}| #\.]+)(?:[^}]+)?\}").unwrap());
167+
static JSDOC_INLINE_TAG_REGEX: LazyLock<Regex> = LazyLock::new(|| {
168+
Regex::new(r"\{@(linkcode|linkplain|link|see)\s*([^}| #\.]+)(?:[^}]+)?\}").unwrap()
169+
});
169170

170171
static JSDOC_TYPE_TAG_REGEX: LazyLock<Regex> =
171172
LazyLock::new(|| Regex::new(r"@(param|returns|type|typedef)\s*\{([^}]+)\}").unwrap());

‎crates/biome_js_analyze/tests/specs/correctness/noUnusedImports/issue_7876_tsdoc_linkcode.ts‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
// See https://github.com/biomejs/biome/issues/7876
2+
3+
// some types for the different locations
4+
import type LinkOnFunction from "mod";
5+
6+
import type LinkOnVariable from "mod";
7+
import type LinkOnClass from "mod";
8+
9+
import type LinkOnClassField from "mod";
10+
import type LinkOnClassMethod from "mod";
11+
import type LinkOnClassConstructor from "mod";
12+
import type LinkOnClassAccessor from "mod";
13+
import type LinkOnClassIndexer from "mod";
14+
15+
import type LinkOnInterface from "mod";
16+
import type LinkOnInterfaceField from "mod";
17+
import type LinkOnInterfaceMethod from "mod";
18+
import type LinkOnInterfaceIndexer from "mod";
19+
20+
import type LinkOnEnum from "mod";
21+
import type LinkOnEnumMember from "mod";
22+
23+
24+
/**
25+
* {@linkcode LinkOnFunction}
26+
*/
27+
function testLinkOnFunction() { }
28+
29+
/**
30+
* {@linkcode LinkOnVariable}
31+
*/
32+
const testLinkOnVariable = 3;
33+
34+
/**
35+
* {@linkcode LinkOnClass}
36+
*/
37+
class TestLinkOnClass { }
38+
39+
class TestLinkOnClassField {
40+
/**
41+
* {@linkcode LinkOnClassField}
42+
*/
43+
field: number;
44+
}
45+
46+
class TestLinkOnClassMethod {
47+
/**
48+
* {@linkcode LinkOnClassMethod}
49+
*/
50+
method(): void { }
51+
}
52+
53+
class TestLinkOnClassConstructor {
54+
/**
55+
* {@linkcode LinkOnClassConstructor}
56+
*/
57+
constructor() { }
58+
}
59+
60+
class TestLinkOnClassAccessor {
61+
/**
62+
* {@linkcode LinkOnClassAccessor}
63+
*/
64+
get accessor(): number { return 0 }
65+
}
66+
67+
class TestLinkOnClassIndexer {
68+
/**
69+
* {@linkcode LinkOnClassIndexer}
70+
*/
71+
[index: number]: string;
72+
}
73+
74+
/**
75+
* {@linkcode LinkOnInterface}
76+
*/
77+
interface TestLinkOnInterface { }
78+
79+
interface TestLinkOnInterfaceField {
80+
/**
81+
* {@linkcode LinkOnInterfaceField}
82+
*/
83+
field: string;
84+
}
85+
86+
interface TestLinkOnInterfaceMethod {
87+
/**
88+
* {@linkcode LinkOnInterfaceMethod}
89+
*/
90+
method(): string;
91+
}
92+
93+
interface TestLinkOnInterfaceIndexer {
94+
/**
95+
* {@linkcode LinkOnInterfaceIndexer}
96+
*/
97+
[index: number]: string;
98+
}
99+
100+
/**
101+
* {@linkcode LinkOnEnum}
102+
*/
103+
enum TestLinkOnEnum {
104+
}
105+
106+
enum TestLinkOnEnumMember {
107+
/**
108+
* {@linkcode LinkOnEnumMember}
109+
*/
110+
member
111+
}

‎crates/biome_js_analyze/tests/specs/correctness/noUnusedImports/issue_7876_tsdoc_linkcode.ts.snap‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
source: crates/biome_js_analyze/tests/spec_tests.rs
3+
expression: issue_7876_tsdoc_linkcode.ts
4+
---
5+
# Input
6+
```ts
7+
// See https://github.com/biomejs/biome/issues/7876
8+
9+
// some types for the different locations
10+
import type LinkOnFunction from "mod";
11+
12+
import type LinkOnVariable from "mod";
13+
import type LinkOnClass from "mod";
14+
15+
import type LinkOnClassField from "mod";
16+
import type LinkOnClassMethod from "mod";
17+
import type LinkOnClassConstructor from "mod";
18+
import type LinkOnClassAccessor from "mod";
19+
import type LinkOnClassIndexer from "mod";
20+
21+
import type LinkOnInterface from "mod";
22+
import type LinkOnInterfaceField from "mod";
23+
import type LinkOnInterfaceMethod from "mod";
24+
import type LinkOnInterfaceIndexer from "mod";
25+
26+
import type LinkOnEnum from "mod";
27+
import type LinkOnEnumMember from "mod";
28+
29+
30+
/**
31+
* {@linkcode LinkOnFunction}
32+
*/
33+
function testLinkOnFunction() { }
34+
35+
/**
36+
* {@linkcode LinkOnVariable}
37+
*/
38+
const testLinkOnVariable = 3;
39+
40+
/**
41+
* {@linkcode LinkOnClass}
42+
*/
43+
class TestLinkOnClass { }
44+
45+
class TestLinkOnClassField {
46+
/**
47+
* {@linkcode LinkOnClassField}
48+
*/
49+
field: number;
50+
}
51+
52+
class TestLinkOnClassMethod {
53+
/**
54+
* {@linkcode LinkOnClassMethod}
55+
*/
56+
method(): void { }
57+
}
58+
59+
class TestLinkOnClassConstructor {
60+
/**
61+
* {@linkcode LinkOnClassConstructor}
62+
*/
63+
constructor() { }
64+
}
65+
66+
class TestLinkOnClassAccessor {
67+
/**
68+
* {@linkcode LinkOnClassAccessor}
69+
*/
70+
get accessor(): number { return 0 }
71+
}
72+
73+
class TestLinkOnClassIndexer {
74+
/**
75+
* {@linkcode LinkOnClassIndexer}
76+
*/
77+
[index: number]: string;
78+
}
79+
80+
/**
81+
* {@linkcode LinkOnInterface}
82+
*/
83+
interface TestLinkOnInterface { }
84+
85+
interface TestLinkOnInterfaceField {
86+
/**
87+
* {@linkcode LinkOnInterfaceField}
88+
*/
89+
field: string;
90+
}
91+
92+
interface TestLinkOnInterfaceMethod {
93+
/**
94+
* {@linkcode LinkOnInterfaceMethod}
95+
*/
96+
method(): string;
97+
}
98+
99+
interface TestLinkOnInterfaceIndexer {
100+
/**
101+
* {@linkcode LinkOnInterfaceIndexer}
102+
*/
103+
[index: number]: string;
104+
}
105+
106+
/**
107+
* {@linkcode LinkOnEnum}
108+
*/
109+
enum TestLinkOnEnum {
110+
}
111+
112+
enum TestLinkOnEnumMember {
113+
/**
114+
* {@linkcode LinkOnEnumMember}
115+
*/
116+
member
117+
}
118+
```

‎crates/biome_js_analyze/tests/specs/correctness/noUnusedImports/issue_7876_tsdoc_linkplain.ts‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
// See https://github.com/biomejs/biome/issues/7876
2+
3+
// some types for the different locations
4+
import type LinkOnFunction from "mod";
5+
6+
import type LinkOnVariable from "mod";
7+
import type LinkOnClass from "mod";
8+
9+
import type LinkOnClassField from "mod";
10+
import type LinkOnClassMethod from "mod";
11+
import type LinkOnClassConstructor from "mod";
12+
import type LinkOnClassAccessor from "mod";
13+
import type LinkOnClassIndexer from "mod";
14+
15+
import type LinkOnInterface from "mod";
16+
import type LinkOnInterfaceField from "mod";
17+
import type LinkOnInterfaceMethod from "mod";
18+
import type LinkOnInterfaceIndexer from "mod";
19+
20+
import type LinkOnEnum from "mod";
21+
import type LinkOnEnumMember from "mod";
22+
23+
24+
/**
25+
* {@linkplain LinkOnFunction}
26+
*/
27+
function testLinkOnFunction() { }
28+
29+
/**
30+
* {@linkplain LinkOnVariable}
31+
*/
32+
const testLinkOnVariable = 3;
33+
34+
/**
35+
* {@linkplain LinkOnClass}
36+
*/
37+
class TestLinkOnClass { }
38+
39+
class TestLinkOnClassField {
40+
/**
41+
* {@linkplain LinkOnClassField}
42+
*/
43+
field: number;
44+
}
45+
46+
class TestLinkOnClassMethod {
47+
/**
48+
* {@linkplain LinkOnClassMethod}
49+
*/
50+
method(): void { }
51+
}
52+
53+
class TestLinkOnClassConstructor {
54+
/**
55+
* {@linkplain LinkOnClassConstructor}
56+
*/
57+
constructor() { }
58+
}
59+
60+
class TestLinkOnClassAccessor {
61+
/**
62+
* {@linkplain LinkOnClassAccessor}
63+
*/
64+
get accessor(): number { return 0 }
65+
}
66+
67+
class TestLinkOnClassIndexer {
68+
/**
69+
* {@linkplain LinkOnClassIndexer}
70+
*/
71+
[index: number]: string;
72+
}
73+
74+
/**
75+
* {@linkplain LinkOnInterface}
76+
*/
77+
interface TestLinkOnInterface { }
78+
79+
interface TestLinkOnInterfaceField {
80+
/**
81+
* {@linkplain LinkOnInterfaceField}
82+
*/
83+
field: string;
84+
}
85+
86+
interface TestLinkOnInterfaceMethod {
87+
/**
88+
* {@linkplain LinkOnInterfaceMethod}
89+
*/
90+
method(): string;
91+
}
92+
93+
interface TestLinkOnInterfaceIndexer {
94+
/**
95+
* {@linkplain LinkOnInterfaceIndexer}
96+
*/
97+
[index: number]: string;
98+
}
99+
100+
/**
101+
* {@linkplain LinkOnEnum}
102+
*/
103+
enum TestLinkOnEnum {
104+
}
105+
106+
enum TestLinkOnEnumMember {
107+
/**
108+
* {@linkplain LinkOnEnumMember}
109+
*/
110+
member
111+
}

0 commit comments

Comments
 (0)