fix(eslint-plugin): [no-misused-promises] factor thenable returning function overload signatures #4620
Conversation
This file contains hidden or 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
…unction overload signatures
|
Thanks for the PR, @JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
|
✔️ Deploy Preview for typescript-eslint ready! 🔨 Explore the source changes: 252e3d9 🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/621f96b15a31d70008ca3fde 😎 Browse the preview: https://deploy-preview-4620--typescript-eslint.netlify.app |
Codecov Report
@@ Coverage Diff @@
## main #4620 +/- ##
==========================================
+ Coverage 92.41% 94.41% +2.00%
==========================================
Files 350 151 -199
Lines 12059 8239 -3820
Branches 3430 2626 -804
==========================================
- Hits 11144 7779 -3365
+ Misses 642 262 -380
+ Partials 273 198 -75
Flags with carried forward coverage won't be shown. Click here to find out more. |
4 tasks
bradzacher
previously approved these changes
Mar 2, 2022
There was a problem hiding this comment.
two more good test cases would be
interface ItLike {
(name: string, callback: () => void): void;
}
interface ItLike {
(name: string, callback: () => Promise<void>): void;
}
declare const it: ItLike;
it('', async () => {});interface ItLike {
(name: string, callback: () => Promise<void>): void;
}
interface ItLike {
(name: string, callback: () => void): void;
}
declare const it: ItLike;
it('', async () => {});because weirdly declaration merged signatures are evaluated in reverse order!
|
(GitHub auto-dismissed the approval) |
bradzacher
approved these changes
Mar 2, 2022
1 task
3 tasks
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
Mar 8, 2022
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.13.0` -> `5.14.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.13.0/5.14.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.13.0` -> `5.14.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.13.0/5.14.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@​typescript-eslint/eslint-plugin)</summary> ### [`v5.14.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5140-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5130v5140-2022-03-07) [Compare Source](typescript-eslint/typescript-eslint@v5.13.0...v5.14.0) ##### Bug Fixes - **eslint-plugin:** \[naming-convention] cover case that requires quotes ([#​4582](typescript-eslint/typescript-eslint#4582)) ([3ea0947](typescript-eslint/typescript-eslint@3ea0947)) - **eslint-plugin:** \[no-misused-promises] factor thenable returning function overload signatures ([#​4620](typescript-eslint/typescript-eslint#4620)) ([56a09e9](typescript-eslint/typescript-eslint@56a09e9)) - **eslint-plugin:** \[prefer-readonly-parameter-types] handle class sharp private field and member without throwing error ([#​4343](typescript-eslint/typescript-eslint#4343)) ([a65713a](typescript-eslint/typescript-eslint@a65713a)) - **eslint-plugin:** \[return-await] correct autofixer in binary expression ([#​4401](typescript-eslint/typescript-eslint#4401)) ([5fa2fad](typescript-eslint/typescript-eslint@5fa2fad)) ##### Features - **eslint-plugin:** \[no-misused-promises] add granular options within `checksVoidReturns` ([#​4623](typescript-eslint/typescript-eslint#4623)) ([1085177](typescript-eslint/typescript-eslint@1085177)) </details> <details> <summary>typescript-eslint/typescript-eslint (@​typescript-eslint/parser)</summary> ### [`v5.14.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5140-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5130v5140-2022-03-07) [Compare Source](typescript-eslint/typescript-eslint@v5.13.0...v5.14.0) **Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1201 Reviewed-by: 6543 <6543@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR Checklist
Overview
Previously the rule checked for any function overload signature that had a
void-returning function for each parameter. Those parameters were then considered unsafe for thenable-returning functions.In an ideal world we would use the type checker's
getResolvedSignatureAPI to grab the specific type signature used for the call instead. However, TypeScript selects the first matching signature, causing it to select one with the() => voidparameter before the() => Promise<void>parameter is seen. microsoft/TypeScript#48077Instead, now we no longer consider any parameter index unsafe if a signature can have a thenable-returning function for it. 😞