Skip to content

fix(lint): update rule diagnostic message for useUnifiedTypeSignature #8378

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
ematipico merged 3 commits into from
Dec 7, 2025
Merged

fix(lint): update rule diagnostic message for useUnifiedTypeSignature #8378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3963574
docs: update rule diagnostic message for `useUnifiedTypeSignature`
Bertie690 Dec 7, 2025
438a622
ran snapshot
Bertie690 Dec 7, 2025
21892d4
Added 1 loc changeset
Bertie690 Dec 7, 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
7 changes: 7 additions & 0 deletions .changeset/eleven-meals-brake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@biomejs/biome": patch
---

Clarify diagnostic message for `lint/style/useUnifiedTypeSignatures`

The rule's diagnostic message now clearly states that multiple _similar_ overload signatures are hard to read & maintain, as opposed to overload signatures in general.
2 changes: 1 addition & 1 deletion crates/biome_js_analyze/src/lint/style/use_unified_type_signatures.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ impl Rule for UseUnifiedTypeSignatures {
rule_category!(),
state.signature_to_remove.overload_range(),
markup! {
"Overload signatures are hard to read and maintain."
"Multiple similar overload signatures are hard to read and maintain."
},
))
}
Expand Down
58 changes: 29 additions & 29 deletions crates/biome_js_analyze/tests/specs/style/useUnifiedTypeSignatures/invalid.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ declare function f10(this: number): void;
```
invalid.ts:1:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

> 1 │ function f1(a: number): void;
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -197,7 +197,7 @@ invalid.ts:1:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:5:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

3 │ function f1(a: number | string): void {}
4 │
Expand All @@ -223,7 +223,7 @@ invalid.ts:5:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:11:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

9 │ }
10 │
Expand All @@ -249,7 +249,7 @@ invalid.ts:11:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:17:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

15 │ }
16 │
Expand All @@ -275,7 +275,7 @@ invalid.ts:17:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:22:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

21 │ interface I1 {
> 22 │ a0(): void;
Expand All @@ -300,7 +300,7 @@ invalid.ts:22:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:28:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

27 │ interface I2 {
> 28 │ a1(): void;
Expand All @@ -324,7 +324,7 @@ invalid.ts:28:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:33:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

32 │ // Exported functions.
> 33 │ export function f4(a: number): void;
Expand Down Expand Up @@ -352,7 +352,7 @@ invalid.ts:33:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:40:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

39 │ // Exported default functions.
> 40 │ export default function f5(a: number): void;
Expand Down Expand Up @@ -380,7 +380,7 @@ invalid.ts:40:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:48:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

46 │ // The second signature is different by single required parameter.
47 │ interface I3 {
Expand All @@ -405,7 +405,7 @@ invalid.ts:48:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:54:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

52 │ // The difference is the rest parameter.
53 │ interface I4 {
Expand All @@ -428,7 +428,7 @@ invalid.ts:54:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:60:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

58 │ // Both parameters are optional.
59 │ interface I5 {
Expand All @@ -453,7 +453,7 @@ invalid.ts:60:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:65:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

64 │ interface I6 {
> 65 │ d(x: number): void;
Expand All @@ -477,7 +477,7 @@ invalid.ts:65:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:71:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

69 │ // Support call signatures in types.
70 │ type T1 = {
Expand All @@ -502,7 +502,7 @@ invalid.ts:71:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:77:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

75 │ // Support call signatures in interfaces.
76 │ interface I7 {
Expand All @@ -527,7 +527,7 @@ invalid.ts:77:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:83:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

81 │ // Supports private methods in classes.
82 │ declare class Example {
Expand All @@ -550,7 +550,7 @@ invalid.ts:83:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:89:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

87 │ // Supports class constructors.
88 │ declare class C {
Expand All @@ -575,7 +575,7 @@ invalid.ts:89:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:95:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

93 │ // Supports unions.
94 │ interface I8 {
Expand All @@ -600,7 +600,7 @@ invalid.ts:95:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━
```
invalid.ts:101:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

99 │ // Supports tuples.
100 │ interface I9 {
Expand All @@ -625,7 +625,7 @@ invalid.ts:101:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:107:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

105 │ // Supports generics.
106 │ interface Generic<T> {
Expand All @@ -650,7 +650,7 @@ invalid.ts:107:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:112:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

111 │ // Merges signatures when type parameters are the same.
> 112 │ function f6<T extends number>(x: T[]): void;
Expand Down Expand Up @@ -678,7 +678,7 @@ invalid.ts:112:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:118:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

116 │ // Supports abstract methods.
117 │ abstract class Foo {
Expand All @@ -703,7 +703,7 @@ invalid.ts:118:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:124:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

122 │ // Supports literal names.
123 │ interface I10 {
Expand All @@ -728,7 +728,7 @@ invalid.ts:124:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:130:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

128 │ // Supports constructor signatures.
129 │ interface Foo {
Expand All @@ -753,7 +753,7 @@ invalid.ts:130:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:136:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

134 │ // Supports computed property names.
135 │ interface IFoo {
Expand All @@ -778,7 +778,7 @@ invalid.ts:136:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:141:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

140 │ declare module 'foo' {
> 141 │ export default function (foo: number): string[];
Expand All @@ -800,7 +800,7 @@ invalid.ts:141:5 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:145:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

143 │ }
144 │
Expand All @@ -826,7 +826,7 @@ invalid.ts:145:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:151:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

149 │ // Transfers JsDoc comments to signatures.
150 │ /** JsDoc 1 */
Expand Down Expand Up @@ -858,7 +858,7 @@ invalid.ts:151:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:157:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

155 │ // Transfers JsDoc comments to signatures even if signatures are not adjacent.
156 │ /** JsDoc 1 */
Expand Down Expand Up @@ -891,7 +891,7 @@ invalid.ts:157:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━
```
invalid.ts:163:1 lint/style/useUnifiedTypeSignatures FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

i Overload signatures are hard to read and maintain.
i Multiple similar overload signatures are hard to read and maintain.

162 │ // Merges "this" params.
> 163 │ declare function f10(this: string): void;
Expand Down
Loading