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 toArray is a void-returning function, and if so, check if any of the variadic arguments return a Promise.

PR Checklist

Addresses an existing open issue:fixes[no-misused-promises] checksVoidReturn=true doesn't catch the error when variadic arguments are used (like...handlers: Array<() => void>) #4015
That issue was marked asaccepting prs
Steps inCONTRIBUTING.md were taken

Overview

Copy link

nx-cloudbot commentedOct 3, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit1342a7e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 fromNxCloud.

Copy link

Contributor

typescript-eslintbot commentedOct 3, 2022

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 visitorsper day.

Copy link

netlifybot commentedOct 3, 2022•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`1342a7e`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63407446e025f1000728a066
😎 Deploy Preview	https://deploy-preview-5731--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to yourNetlify site settings.

feat(eslint-plugin): Check 'rest' parameters in no-misused-promises

0bb293b

Fixestypescript-eslint#4015This extends 'no-misued-promises' with support for checkingvariadic arguments passed to a 'rest' parameter. If a functionis 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.

Aaron1011 force-pushed themisused-promise-rest branch from0562de3 to0bb293bCompare

October 3, 2022 21:41

Copy link

codecovbot commentedOct 3, 2022•
edited
Loading

Codecov Report

Merging#5731 (3a3bb21) intomain (7a377e4) willincrease coverage by0.13%.
The diff coverage is100.00%.

❗ Current head3a3bb21 differs from pull request most recent head1342a7e. Consider uploading reports for the commit1342a7e to get more accurate results

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

Flag	Coverage Δ
unittest	`93.96% <100.00%> (+0.13%)`	⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

Impacted Files	Coverage Δ
...ges/eslint-plugin/src/rules/no-misused-promises.ts	`98.46% <100.00%> (ø)`
...nt-plugin/src/rules/consistent-type-definitions.ts	`97.29% <0.00%> (ø)`
...s/eslint-plugin/src/rules/no-unused-expressions.ts	`89.47% <0.00%> (ø)`
packages/eslint-plugin/src/util/objectIterators.ts	`66.66% <0.00%> (ø)`
packages/eslint-plugin/src/rules/ban-ts-comment.ts	`96.96% <0.00%> (ø)`
...ackages/eslint-plugin/src/rules/member-ordering.ts	`95.62% <0.00%> (ø)`
...plugin/src/rules/explicit-module-boundary-types.ts	`91.04% <0.00%> (ø)`
...lugin/src/rules/prefer-readonly-parameter-types.ts	`100.00% <0.00%> (ø)`
packages/eslint-plugin/src/util/isNullLiteral.ts	`100.00% <0.00%> (ø)`
...ackages/eslint-plugin/src/rules/prefer-as-const.ts	`100.00% <0.00%> (ø)`
... and145 more

JoshuaKGoldberg reviewed

Oct 4, 2022

View reviewed changes

packages/eslint-plugin/src/rules/no-misused-promises.tsShow resolvedHide resolved

JoshuaKGoldberg requested changes

Oct 4, 2022

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a 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!

packages/eslint-plugin/src/rules/no-misused-promises.ts OutdatedShow resolvedHide resolved

packages/eslint-plugin/tests/rules/no-misused-promises.test.tsShow resolvedHide resolved

packages/eslint-plugin/src/rules/no-misused-promises.ts OutdatedShow resolvedHide resolved

JoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party label

Oct 4, 2022

Aaron1011 mentioned this pull request

Oct 4, 2022

Bug: [no-misused-promises] An array of promises passed with spread (...args) syntax is not checked#5744

Closed

4 tasks

Copy link

ContributorAuthor

Aaron1011 commentedOct 4, 2022

@JoshuaKGoldberg Thanks for the fast review! I've pushed a new commit that should address all of your comments.

Aaron1011 added2 commits

October 4, 2022 17:25

Address review comments

aac48e9

Fix spelling

5f91551

Aaron1011 force-pushed themisused-promise-rest branch fromdec854c to5f91551Compare

October 4, 2022 22:26

JoshuaKGoldberg requested changes

Oct 5, 2022

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment•
edited
Loading

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!

packages/eslint-plugin/src/rules/no-misused-promises.ts OutdatedShow resolvedHide resolved

packages/eslint-plugin/src/rules/no-misused-promises.tsShow resolvedHide resolved

packages/eslint-plugin/tests/rules/no-misused-promises.test.tsShow resolvedHide resolved

Address additional review comments

0f01987

Copy link

ContributorAuthor

Aaron1011 commentedOct 5, 2022

@JoshuaKGoldberg I've addressed your latest comments

nit: split up tests a bit, and add comments about ()

3a3bb21

JoshuaKGoldbergenabled auto-merge (squash)

October 7, 2022 18:46

JoshuaKGoldberg approved these changes

Oct 7, 2022

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fantastic, thanks! 👏

JoshuaKGoldberg removed the awaiting responseIssues waiting for a reply from the OP or another party label

Oct 7, 2022

Merge branch 'main' into misused-promise-rest

1342a7e

JoshuaKGoldberg merged commit6477f38 intotypescript-eslint:main

Oct 7, 2022

Aaron1011 deleted the misused-promise-rest branch

October 7, 2022 19:18

Copy link

jlowcs commentedOct 11, 2022•
edited
Loading

Following this change, my project's linting broke. I'm seeing the following:

TypeError: Cannot read properties of undefined (reading 'flags')Occurred while linting /tmp/workspace/x/y/z/index.ts:19Rule: "@typescript-eslint/no-misused-promises"    at Object.isUnionType (/tmp/workspace/node_modules/tsutils/typeguard/2.8/type.ts:68:18)    at Object.unionTypeParts (/tmp/workspace/node_modules/tsutils/util/type.ts:145:12)    at isThenableReturningFunctionType (/tmp/workspace/node_modules/@typescript-eslint/eslint-plugin/src/rules/no-misused-promises.ts:625:33)    at checkThenableOrVoidArgument (/tmp/workspace/node_modules/@typescript-eslint/eslint-plugin/src/rules/no-misused-promises.ts:497:7)    at voidFunctionArguments (/tmp/workspace/node_modules/@typescript-eslint/eslint-plugin/src/rules/no-misused-promises.ts:568:15)    at checkArguments (/tmp/workspace/node_modules/@typescript-eslint/eslint-plugin/src/rules/no-misused-promises.ts:216:24)    at ruleErrorHandler (/tmp/workspace/node_modules/eslint/lib/linter/linter.js:1114:28)    at /tmp/workspace/node_modules/eslint/lib/linter/safe-emitter.js:45:58    at Array.forEach (<anonymous>)    at Object.emit (/tmp/workspace/node_modules/eslint/lib/linter/safe-emitter.js:45:38)

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:

functiongetInnerValue(...args:readonly[]):undefined;functiongetInnerValue(...args:readonly[string]):undefined;functiongetInnerValue(..._args:readonlystring[]):undefined{returnundefined;}exportfunctiongetValue():undefined{returngetInnerValue('a');}

But this does not:

functiongetInnerValue(args:readonly[]):undefined;functiongetInnerValue(args:readonly[string]):undefined;functiongetInnerValue(_args:readonlystring[]):undefined{returnundefined;}exportfunctiongetValue():undefined{returngetInnerValue(['a']);}

And neither does this:

functiongetInnerValue(...args:readonlystring[]):undefined{returnundefined;}exportfunctiongetValue():undefined{returngetInnerValue('a');}

Copy link

jlowcs commentedOct 11, 2022

submitted an issue:#5807

crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request

Oct 13, 2022

Update typescript-eslint monorepo to v5.40.0 (#1580)

746143e

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 (@&#8203;typescript-eslint/eslint-plugin)</summary>### [`v5.40.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;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 ([#&#8203;5746](typescript-eslint/typescript-eslint#5746)) ([7a8a0a3](typescript-eslint/typescript-eslint@7a8a0a3))-   **eslint-plugin:** \[no-unnecessary-condition] handle void ([#&#8203;5766](typescript-eslint/typescript-eslint#5766)) ([ac8f06b](typescript-eslint/typescript-eslint@ac8f06b))##### Features-   **eslint-plugin:** Check 'rest' parameters in no-misused-promises ([#&#8203;5731](typescript-eslint/typescript-eslint#5731)) ([6477f38](typescript-eslint/typescript-eslint@6477f38)), closes [#&#8203;4015](typescript-eslint/typescript-eslint#4015)-   **utils:** add dependency constraint filtering for `RuleTester` ([#&#8203;5750](typescript-eslint/typescript-eslint#5750)) ([121f4c0](typescript-eslint/typescript-eslint@121f4c0))</details><details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>### [`v5.40.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;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 [@&#8203;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/1580Reviewed-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>

sync-by-unitobot mentioned this pull request

Oct 17, 2022

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.30.6 to 5.40.0SmartTokenLabs/token-negotiator#424

Merged

sync-by-unitobot mentioned this pull request

Oct 25, 2022

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.36.1 to 5.41.0numbersprotocol/capture-lite#2211

Closed

sync-by-unitobot mentioned this pull request

Nov 1, 2022

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.36.1 to 5.42.0numbersprotocol/capture-lite#2265

Closed

github-actionsbot locked asresolvedand limited conversation to collaborators

Nov 11, 2022

Labels

None yet

3 participants

Movatterモバイル変換

Uh oh!

feat(eslint-plugin): Check 'rest' parameters in no-misused-promises#5731

feat(eslint-plugin): Check 'rest' parameters in no-misused-promises#5731

Uh oh!

Conversation

Aaron1011 commentedOct 3, 2022

PR Checklist

Overview

Uh oh!

nx-cloudbot commentedOct 3, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

typescript-eslintbot commentedOct 3, 2022

Uh oh!

netlifybot commentedOct 3, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

codecovbot commentedOct 3, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Aaron1011 commentedOct 4, 2022

Uh oh!

JoshuaKGoldberg left a comment• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Aaron1011 commentedOct 5, 2022

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

jlowcs commentedOct 11, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

jlowcs commentedOct 11, 2022

Uh oh!

Uh oh!

nx-cloudbot commentedOct 3, 2022•
edited
Loading

netlifybot commentedOct 3, 2022•
edited
Loading

codecovbot commentedOct 3, 2022•
edited
Loading

JoshuaKGoldberg left a comment•
edited
Loading

jlowcs commentedOct 11, 2022•
edited
Loading