fix(eslint-plugin): [no-misused-promises] improve report loc for methods #10216

gyumong · 2024-10-27T08:38:02Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-misused-promises] bad report loc for methods in object literals #10212
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This PR fixes an issue in the no-misused-promises rule where async methods within object literals that return a Promise were not correctly reported when a void return was expected.

…ng Promise where void is expected

typescript-eslint · 2024-10-27T08:38:05Z

Thanks for the PR, @gyumong!

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.

netlify · 2024-10-27T08:38:18Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`eb66dbd`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/672d91475776240008c5c37c
😎 Deploy Preview	https://deploy-preview-10216--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 92 (no change from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

nx-cloud · 2024-10-27T08:39:00Z

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

codecov · 2024-10-27T08:52:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.57%. Comparing base (124b65d) to head (eb66dbd).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10216   +/-   ##
=======================================
  Coverage   86.56%   86.57%           
=======================================
  Files         431      431           
  Lines       15188    15196    +8     
  Branches     4418     4421    +3     
=======================================
+ Hits        13148    13156    +8     
  Misses       1683     1683           
  Partials      357      357

Flag	Coverage Δ
unittest	`86.57% <100.00%> (+<0.01%)`	⬆️

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

Files with missing lines	Coverage Δ
...ges/eslint-plugin/src/rules/no-misused-promises.ts	`97.73% <100.00%> (+0.07%)`	⬆️

JoshuaKGoldberg

Good start! Let's streamline this a bit?

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

packages/eslint-plugin/tests/rules/no-misused-promises.test.ts

kirkwaiblinger

Couple more changes, but I think we're in pretty good shape 🙂

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

packages/eslint-plugin/tests/rules/no-misused-promises.test.ts

…t cases”

…t async

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

kirkwaiblinger

A lovely first contribution to typescript-eslint! Thanks for sending this in!

The PR will stay open for a bit before merging to give @JoshuaKGoldberg a chance to re-review as well

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

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

… return validation

kirkwaiblinger

Love it!

JoshuaKGoldberg

🙌 yay!

@gyumong

##### [v8.14.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8140-2024-11-11) ##### 🚀 Features - **eslint-plugin:** \[await-thenable] report unnecessary `await using` statements ([#10209](typescript-eslint/typescript-eslint#10209)) - **eslint-plugin:** \[no-confusing-void-expression] add an option to ignore void<->void ([#10067](typescript-eslint/typescript-eslint#10067)) ##### 🩹 Fixes - **scope-manager:** fix asserted increments not being marked as write references ([#10271](typescript-eslint/typescript-eslint#10271)) - **eslint-plugin:** \[no-misused-promises] improve report loc for methods ([#10216](typescript-eslint/typescript-eslint#10216)) - **eslint-plugin:** \[no-unnecessary-condition] improve error message for literal comparisons ([#10194](typescript-eslint/typescript-eslint#10194)) ##### ❤️ Thank You - Gyumong [@gyumong](https://github.com/Gyumong) - Jan Ochwat [@janek515](https://github.com/janek515) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@gyumong

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.13.0 | 8.14.0 | | npm | @typescript-eslint/parser | 8.13.0 | 8.14.0 | ## [v8.14.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8140-2024-11-11) ##### 🚀 Features - **eslint-plugin:** \[await-thenable] report unnecessary `await using` statements ([#10209](typescript-eslint/typescript-eslint#10209)) - **eslint-plugin:** \[no-confusing-void-expression] add an option to ignore void<->void ([#10067](typescript-eslint/typescript-eslint#10067)) ##### 🩹 Fixes - **scope-manager:** fix asserted increments not being marked as write references ([#10271](typescript-eslint/typescript-eslint#10271)) - **eslint-plugin:** \[no-misused-promises] improve report loc for methods ([#10216](typescript-eslint/typescript-eslint#10216)) - **eslint-plugin:** \[no-unnecessary-condition] improve error message for literal comparisons ([#10194](typescript-eslint/typescript-eslint#10194)) ##### ❤️ Thank You - Gyumong [@gyumong](https://github.com/Gyumong) - Jan Ochwat [@janek515](https://github.com/janek515) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@gyumong

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.13.0 | 8.14.0 | | npm | @typescript-eslint/parser | 8.13.0 | 8.14.0 | ## [v8.14.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8140-2024-11-11) ##### 🚀 Features - **eslint-plugin:** \[await-thenable] report unnecessary `await using` statements ([#10209](typescript-eslint/typescript-eslint#10209)) - **eslint-plugin:** \[no-confusing-void-expression] add an option to ignore void<->void ([#10067](typescript-eslint/typescript-eslint#10067)) ##### 🩹 Fixes - **scope-manager:** fix asserted increments not being marked as write references ([#10271](typescript-eslint/typescript-eslint#10271)) - **eslint-plugin:** \[no-misused-promises] improve report loc for methods ([#10216](typescript-eslint/typescript-eslint#10216)) - **eslint-plugin:** \[no-unnecessary-condition] improve error message for literal comparisons ([#10194](typescript-eslint/typescript-eslint#10194)) ##### ❤️ Thank You - Gyumong [@gyumong](https://github.com/Gyumong) - Jan Ochwat [@janek515](https://github.com/janek515) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

fix(eslint-plugin): correctly report errors for async methods returni…

359e052

…ng Promise where void is expected

gyumong changed the title ~~fix(eslint-plugin): correctly report errors for async methods returni…~~ fix(eslint-plugin): [no-minused-promises] correctly report errors for async methods returni… Oct 27, 2024

gyumong changed the title ~~fix(eslint-plugin): [no-minused-promises] correctly report errors for async methods returni…~~ fix(eslint-plugin): [no-minused-promises] report errors for async methods returning Promise Oct 27, 2024

gyumong added 2 commits October 27, 2024 18:49

test add coverage

d8c6635

fix: remove unreachable code

3d26e12

kirkwaiblinger changed the title ~~fix(eslint-plugin): [no-minused-promises] report errors for async methods returning Promise~~ fix(eslint-plugin): [no-misused-promises] report errors for async methods returning Promise Oct 27, 2024

JoshuaKGoldberg requested changes Oct 27, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-misused-promises.ts Show resolved Hide resolved

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Oct 27, 2024

kirkwaiblinger reviewed Oct 27, 2024

View reviewed changes

packages/eslint-plugin/tests/rules/no-misused-promises.test.ts Outdated Show resolved Hide resolved

gyumong and others added 6 commits October 28, 2024 03:45

fix: simplify redundant if checks in context.report logic

a5dbd87

test: specify error location in voidReturnProperty test cases

a762f40

Merge branch 'main' into fix-no-misused-promises

8b1393c

fix lint

432b792

Merge branch 'main' into fix-no-misused-promises

2207c17

Merge branch 'main' into fix-no-misused-promises

aa8f8c6

kirkwaiblinger requested changes Oct 29, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-misused-promises.ts Outdated Show resolved Hide resolved

packages/eslint-plugin/src/rules/no-misused-promises.ts Outdated Show resolved Hide resolved

packages/eslint-plugin/tests/rules/no-misused-promises.test.ts Outdated Show resolved Hide resolved

gyumong and others added 5 commits October 31, 2024 20:18

test: add full loc (line, endLine, column, endColumn) to existing tes…

4c7d787

…t cases”

test: add new invalid test cases for promise-returning methods withou…

65ae628

…t async

fix : test col

801bf4c

fix: log

f367c20

Merge branch 'main' into fix-no-misused-promises

09be707

gyumong requested review from JoshuaKGoldberg and kirkwaiblinger October 31, 2024 11:40

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Oct 31, 2024

kirkwaiblinger reviewed Oct 31, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-misused-promises.ts Outdated Show resolved Hide resolved

kirkwaiblinger changed the title ~~fix(eslint-plugin): [no-misused-promises] report errors for async methods returning Promise~~ fix(eslint-plugin): [no-misused-promises] improve report loc for methods Oct 31, 2024

kirkwaiblinger approved these changes Oct 31, 2024

View reviewed changes

kirkwaiblinger requested changes Oct 31, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-misused-promises.ts Show resolved Hide resolved

Update packages/eslint-plugin/src/rules/no-misused-promises.ts

e79283c

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label Nov 4, 2024

gyumong and others added 6 commits November 4, 2024 16:06

Merge branch 'main' into fix-no-misused-promises

1278e3d

refactor(no-misused-promises): improve function type checking in void…

2bc7666

… return validation

test(no-misused-promises): add test cases for isFunction utility usage

2da0b5c

Merge branch 'main' into fix-no-misused-promises

ac34e36

test(no-misused-promises): add test cases

c7ac4e6

Merge branch 'main' into fix-no-misused-promises

50a6252

gyumong requested a review from kirkwaiblinger November 6, 2024 15:47

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Nov 6, 2024

kirkwaiblinger approved these changes Nov 8, 2024

View reviewed changes

kirkwaiblinger added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Nov 8, 2024

Merge branch 'main' into fix-no-misused-promises

eb66dbd

JoshuaKGoldberg approved these changes Nov 10, 2024

View reviewed changes

JoshuaKGoldberg merged commit d27a9ac into typescript-eslint:main Nov 10, 2024
62 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Nov 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [no-misused-promises] improve report loc for methods #10216

fix(eslint-plugin): [no-misused-promises] improve report loc for methods #10216

gyumong commented Oct 27, 2024 •

edited

Loading

typescript-eslint bot commented Oct 27, 2024

netlify bot commented Oct 27, 2024 •

edited

Loading

nx-cloud bot commented Oct 27, 2024 •

edited

Loading

codecov bot commented Oct 27, 2024 •

edited

Loading

JoshuaKGoldberg left a comment

kirkwaiblinger left a comment

kirkwaiblinger left a comment

kirkwaiblinger left a comment

JoshuaKGoldberg left a comment

fix(eslint-plugin): [no-misused-promises] improve report loc for methods #10216

fix(eslint-plugin): [no-misused-promises] improve report loc for methods #10216

Conversation

gyumong commented Oct 27, 2024 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Oct 27, 2024

netlify bot commented Oct 27, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Oct 27, 2024 • edited Loading

☁️ Nx Cloud Report

codecov bot commented Oct 27, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

kirkwaiblinger left a comment

Choose a reason for hiding this comment

kirkwaiblinger left a comment

Choose a reason for hiding this comment

kirkwaiblinger left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

gyumong commented Oct 27, 2024 •

edited

Loading

netlify bot commented Oct 27, 2024 •

edited

Loading

nx-cloud bot commented Oct 27, 2024 •

edited

Loading

codecov bot commented Oct 27, 2024 •

edited

Loading