-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
feat(eslint-plugin): Check 'rest' parameters in no-misused-promises #5731
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.
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
feat(eslint-plugin): Check 'rest' parameters in no-misused-promises #5731
Conversation
Thanks for the PR, @Aaron1011! 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!
To edit notification comments on pull requests, go to your Netlify site settings. |
Fixes typescript-eslint#4015 This extends 'no-misued-promises' with support for checking variadic arguments passed to a 'rest' parameter. If a function is declared with an argument like '...handlers: Array<() => void>', we now check if the type argument to `Array` is a void-returning function, and if so, check if any of the variadic arguments return a Promise.
0562de3
to
0bb293b
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #5731 +/- ##
==========================================
+ Coverage 93.82% 93.96% +0.13%
==========================================
Files 134 288 +154
Lines 1506 9592 +8086
Branches 226 2889 +2663
==========================================
+ Hits 1413 9013 +7600
- Misses 60 333 +273
- Partials 33 246 +213
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a great start, thanks for sending this in! Mostly requesting changes around adding unit test coverage for more edge cases, in particular tuples. Cheers!
@JoshuaKGoldberg Thanks for the fast review! I've pushed a new commit that should address all of your comments. |
dec854c
to
5f91551
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking good! Just a couple non-nits blocking. I'm feeling good about this one!
@JoshuaKGoldberg I've addressed your latest comments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fantastic, thanks! 👏
Following this change, my project's linting broke. I'm seeing the following:
The issue seems to be coming from a function being called in that file. That function is defined in a polymorphism manner with rest args. For instance, this produces the error: function getInnerValue(...args: readonly []): undefined;
function getInnerValue(...args: readonly [string]): undefined;
function getInnerValue(..._args: readonly string[]): undefined {
return undefined;
}
export function getValue(): undefined {
return getInnerValue('a');
} But this does not: function getInnerValue(args: readonly []): undefined;
function getInnerValue(args: readonly [string]): undefined;
function getInnerValue(_args: readonly string[]): undefined {
return undefined;
}
export function getValue(): undefined {
return getInnerValue(['a']);
} And neither does this: function getInnerValue(...args: readonly string[]): undefined {
return undefined;
}
export function getValue(): undefined {
return getInnerValue('a');
} |
submitted an issue: #5807 |
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.39.0` -> `5.40.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.39.0/5.40.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.39.0` -> `5.40.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.39.0/5.40.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@​typescript-eslint/eslint-plugin)</summary> ### [`v5.40.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5400-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5390v5400-2022-10-10) [Compare Source](typescript-eslint/typescript-eslint@v5.39.0...v5.40.0) ##### Bug Fixes - **eslint-plugin:** \[consistent-indexed-object-style] handle interface generic ([#​5746](typescript-eslint/typescript-eslint#5746)) ([7a8a0a3](typescript-eslint/typescript-eslint@7a8a0a3)) - **eslint-plugin:** \[no-unnecessary-condition] handle void ([#​5766](typescript-eslint/typescript-eslint#5766)) ([ac8f06b](typescript-eslint/typescript-eslint@ac8f06b)) ##### Features - **eslint-plugin:** Check 'rest' parameters in no-misused-promises ([#​5731](typescript-eslint/typescript-eslint#5731)) ([6477f38](typescript-eslint/typescript-eslint@6477f38)), closes [#​4015](typescript-eslint/typescript-eslint#4015) - **utils:** add dependency constraint filtering for `RuleTester` ([#​5750](typescript-eslint/typescript-eslint#5750)) ([121f4c0](typescript-eslint/typescript-eslint@121f4c0)) </details> <details> <summary>typescript-eslint/typescript-eslint (@​typescript-eslint/parser)</summary> ### [`v5.40.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5400-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5390v5400-2022-10-10) [Compare Source](typescript-eslint/typescript-eslint@v5.39.0...v5.40.0) **Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - 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). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4yMjYuMCIsInVwZGF0ZWRJblZlciI6IjMyLjIyNi4wIn0=--> Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1580 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Fixes #4015
This extends 'no-misued-promises' with support for checking variadic arguments passed to a 'rest' parameter. If a function is declared with an argument like '...handlers: Array<() => void>', we now check if the type argument to
Array
is a void-returning function, and if so, check if any of the variadic arguments return a Promise.PR Checklist
...handlers: Array<() => void>
) #4015Overview