feat(eslint-plugin): [no-misused-promises] add granular options within checksVoidReturns

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing issue: fixes [no-misused-promises] async react callback properties when void expected #4619
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Allows user configurations to provide an object containing opt-outs for:

interface ChecksVoidReturnOptions {
  arguments?: boolean;
  attributes?: boolean;
  properties?: boolean;
  returns?: boolean;
  variables?: boolean;
}

Specifically the arguments one should be useful for folks #4619. Folks who don't mind passing a () => Promise<void> to a () => void handler, such as React button clicks, can disable it with:

{
  "@typescript-eslint/no-misused-promises": [
    "error",
    {
      "checksVoidReturn": {
        "arguments": false
      }
    }
  ]
}

...though we should note per #4619 (comment) that doing so is silencing a legitimate report about a misused promise. The "proper" (safe) behavior would be to create some kind of wrapAsyncFunction as mentioned in #4619 (comment).

[nx-cloud]

☁️ Nx Cloud Report

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

📂 See all runs for this branch

---

✅ Successfully ran 48 targets

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

---

Sent with 💌 from NxCloud.

[typescript-eslint]

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.

[netlify]

❌ Deploy Preview for typescript-eslint failed.

🔨 Explore the source changes: f921726

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

[codecov]

Codecov Report

Merging #4623 (f921726) into main (fabfc2b) will increase coverage by 1.82%.
The diff coverage is 97.77%.

@@            Coverage Diff             @@
##             main    #4623      +/-   ##
==========================================
+ Coverage   92.41%   94.23%   +1.82%     
==========================================
  Files         350      151     -199     
  Lines       12059     7948    -4111     
  Branches     3430     2572     -858     
==========================================
- Hits        11144     7490    -3654     
+ Misses        642      262     -380     
+ Partials      273      196      -77     

Flag	Coverage Δ
unittest	94.23% <97.77%> (+1.82%)	⬆️

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

Impacted Files	Coverage Δ
...nt-plugin/src/rules/consistent-type-definitions.ts	97.14% <92.85%> (-0.16%)	⬇️
...ges/eslint-plugin/src/rules/no-misused-promises.ts	98.24% <97.29%> (-0.40%)	⬇️
...gin/src/rules/naming-convention-utils/validator.ts	94.96% <100.00%> (-0.55%)	⬇️
...es/eslint-plugin/src/rules/prefer-function-type.ts	97.14% <100.00%> (-0.05%)	⬇️
...es/eslint-plugin/src/util/getOperatorPrecedence.ts	31.42% <0.00%> (-28.58%)	⬇️
.../src/rules/sort-type-union-intersection-members.ts	90.74% <0.00%> (-1.80%)	⬇️
...ackages/eslint-plugin/src/rules/no-invalid-this.ts	78.26% <0.00%> (-1.74%)	⬇️
...ckages/eslint-plugin/src/rules/no-magic-numbers.ts	81.25% <0.00%> (-1.45%)	⬇️
...s/eslint-plugin/src/rules/no-implicit-any-catch.ts	83.33% <0.00%> (-1.29%)	⬇️
.../eslint-plugin/src/rules/method-signature-style.ts	87.65% <0.00%> (-1.24%)	⬇️
... and 301 more

[JoshuaKGoldberg]

👋 @uhyo, just a heads up following #4541

[bradzacher]

implementation looks good - just one comment around documentation

[uhyo]

Sorry, I should have considered adding those options from start. Thank you for follow-up! 😄

[bradzacher]

NOICE