feat(linter): implement useExplicitFunctionReturnType #3990
+462
−11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
A-Project
kaykdm
commented
Sep 19, 2024
Comment on lines
+2
to
+22
| function test(): void { | ||
| return; | ||
| } | ||
|
|
||
| var fn = function (): number { | ||
| return 1; | ||
| }; | ||
|
|
||
| var arrowFn = (): string => 'test'; | ||
|
|
||
| class Test { | ||
| constructor() {} | ||
| get prop(): number { | ||
| return 1; | ||
| } | ||
| set prop() {} | ||
| method(): void { | ||
| return; | ||
| } | ||
| arrow = (): string => 'arrow'; | ||
| } |
There was a problem hiding this comment.
kaykdm
commented
Sep 19, 2024
Comment on lines
+1
to
+28
| function test(a: number, b: number) { | ||
| return; | ||
| } | ||
|
|
||
| function test() { | ||
| return; | ||
| } | ||
|
|
||
| var fn = function () { | ||
| return 1; | ||
| }; | ||
|
|
||
| var arrowFn = () => "test"; | ||
|
|
||
| class Test { | ||
| constructor() {} | ||
| get prop() { | ||
| return 1; | ||
| } | ||
| set prop() {} | ||
| method() { | ||
| return; | ||
| } | ||
| arrow = () => "arrow"; | ||
| private method() { | ||
| return; | ||
| } | ||
| } |
There was a problem hiding this comment.
arendjr
approved these changes
Sep 19, 2024
| /// Leaving off the return type is less code to read or write and allows the compiler to infer it from the contents of the function. | ||
| /// | ||
| /// However, explicit return types do make it visually more clear what type is returned by a function. | ||
| /// They can also speed up TypeScript type checking performance in large codebases with many large functions. |
There was a problem hiding this comment.
Might be nice to add that explicit return types also reduce the chance of bugs by asserting the return type and it avoids surprising "action at a distance", where changing the body of one function may cause failures inside another function.
| /// return; | ||
| /// } | ||
| /// } | ||
| /// ``` |
There was a problem hiding this comment.
What about a function without any explicit return statement? Is the type annotation required there too? If not, might be good to point out in the examples.
CodSpeed Performance ReportMerging #3990 will degrade performances by 6.15%Comparing Summary
Benchmarks breakdown
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Related issue: #2017
This PR introduces the @typescript-eslint/explicit-function-return-type rule to Biome. Currently, it only enforces the basic cases without any additional options configured.
In future PRs, I will implement each option for this rule separately. Due to the complexity of the implementation, handling each option individually will allow for thorough testing and easier review.
original implementation
Todos
I will implement each option for this rule separately in different PRs