feat(eslint-plugin): [no-misused-promises] check more places for checksVoidReturn

[uhyo]

PR Checklist

• Addresses an existing issue: fixes [no-misused-promises] Suggestion: check more AST positions #4523 (Note: the issue is currently closed, but I believe it could be reopened)
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

The checksVoidReturn: true option only checks function arguments now. This PR extends the rule so that misused Promises at other places are checked too. Namely, variable assignments, object properties, return statements and JSX props are newly checked.

See the added tests for examples of newly-incorrect code.

[nx-cloud]

☁️ Nx Cloud Report

CI ran the following commands for commit 42701f5. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 48 targets

• Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12.x - nx test @typescript-eslint/eslint-plugin
• Node 16.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 16.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx test @typescript-eslint/eslint-plugin-internal
• Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 14.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12.x - nx test @typescript-eslint/eslint-plugin
• Node 14.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx run-many --target=typecheck --all --parallel
• Node 12.x - nx test @typescript-eslint/parser
• Node 14.x - nx test @typescript-eslint/parser
• Node 12.x - nx test @typescript-eslint/type-utils
• Node 14.x - nx test @typescript-eslint/type-utils
• Node 12.x - nx test @typescript-eslint/utils
• Node 14.x - nx test @typescript-eslint/utils
• Node 12.x - nx test @typescript-eslint/scope-manager
• Node 14.x - nx test @typescript-eslint/scope-manager
• Node 12.x - nx test @typescript-eslint/visitor-keys
• Node 14.x - nx test @typescript-eslint/visitor-keys
• Node 12.x - nx test @typescript-eslint/typescript-estree
• Node 16.x - nx test @typescript-eslint/parser
• Node 14.x - nx test @typescript-eslint/typescript-estree
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 16.x - nx test @typescript-eslint/type-utils
• Node 14.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 16.x - nx test @typescript-eslint/utils
• Node 16.x - nx test @typescript-eslint/scope-manager
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 16.x - nx test @typescript-eslint/visitor-keys
• Node 16.x - nx test @typescript-eslint/typescript-estree
• Node 16.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx test @typescript-eslint/parser
• Node 12.x - nx test @typescript-eslint/type-utils
• Node 12.x - nx test @typescript-eslint/utils
• Node 12.x - nx test @typescript-eslint/scope-manager
• Node 12.x - nx test @typescript-eslint/visitor-keys
• Node 12.x - nx test @typescript-eslint/typescript-estree
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 14.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 16.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @uhyo!

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.

[netlify]

❌ Deploy Preview for typescript-eslint failed.

🔨 Explore the source changes: 42701f5

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/6217b76f95b0d100079e1af4

[codecov]

Codecov Report

Merging #4541 (42701f5) into main (823b945) will increase coverage by 0.03%.
The diff coverage is 98.11%.

@@            Coverage Diff             @@
##             main    #4541      +/-   ##
==========================================
+ Coverage   94.62%   94.65%   +0.03%     
==========================================
  Files         149      150       +1     
  Lines        8072     8162      +90     
  Branches     2581     2617      +36     
==========================================
+ Hits         7638     7726      +88     
- Misses        239      241       +2     
  Partials      195      195              

Flag	Coverage Δ
unittest	94.65% <98.11%> (+0.03%)	⬆️

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

Impacted Files	Coverage Δ
packages/eslint-plugin/src/configs/all.ts	100.00% <ø> (ø)
...ckages/eslint-plugin/src/util/getESLintCoreRule.ts	75.00% <ø> (ø)
...ges/eslint-plugin/src/rules/no-misused-promises.ts	98.63% <97.18%> (-1.37%)	⬇️
...ackages/eslint-plugin/src/rules/member-ordering.ts	95.68% <100.00%> (+0.12%)	⬆️
.../src/rules/sort-type-union-intersection-members.ts	92.53% <100.00%> (+0.11%)	⬆️
...ges/eslint-plugin/src/rules/space-before-blocks.ts	100.00% <100.00%> (ø)

[JoshuaKGoldberg]

...is there a collective group project or hackathon going on or something? A micro viral tweet? I did not expect this PR to be so popular so quick after posting 😄

🙏 ✨

[JoshuaKGoldberg]

Generally looks great to me so far, thanks for tackling all these cases @uhyo!

Requesting changes on the error message I commented on. Also, codecov (now that it's done changing its mind) is correct, there are some untested lines of code. Please do fill those in.

[uhyo]

@JoshuaKGoldberg Thank you for review!
Coverage is now 100% and I addressed your points. 🙏

[JoshuaKGoldberg]

Sorry, one more bug? 😄

[JoshuaKGoldberg]

🔥

[lgenzelis]

thanks for the improvement @uhyo ! I'm wondering, is there a way to disable only the Promise-returning function provided to attribute where a void return was expected error? I find it too strict for my React codebase. I have code like this in many places:

function MyButton() {
   const onClick = async () => {
      const b = await doSomething();
      doSomethingElse(b);
   }

  return <button onClick={onClick}>Click me!</button>;
}

and now that error is being (correctly!) detected on those places.

I know I could do '@typescript-eslint/no-misused-promises': ['error', { checksVoidReturn: false }],, but I don't want to disable all the other error cases. I'm wondering if something more like '@typescript-eslint/no-misused-promises': ['error', { checksVoidReturningArgument: false }], exists / is on the roadmap.

[bradzacher]

As per our contributing guide - please don't comment on closed PRs.

Instead please use issues to start new discussions and find existing ones like #4619 or #4609