fix(eslint-plugin): [promise-function-async] use a different error message for functions with promise and non-promise types by ronami · Pull Request #10950 · typescript-eslint/typescript-eslint

ronami · 2025-03-14T14:38:32Z

PR Checklist

Addresses an existing open issue: fixes Bug: promise-function-async is reporting on () => A | Promise<B> #10687
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This PR addresses #10687 and adds a custom error message for functions with hybrid return types (and no return type annotation).

Random thought: Should this be a suggestion instead of an auto-fix in this case?

typescript-eslint · 2025-03-14T14:38:36Z

Thanks for the PR, @ronami!

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 · 2025-03-14T14:38:49Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`489037c`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/67f1160a714f270008760b1d
😎 Deploy Preview	https://deploy-preview-10950--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 5 from production) Accessibility: 100 (no change from production) Best Practices: 100 (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 · 2025-03-14T14:39:21Z

View your CI Pipeline Execution ↗ for commit 489037c.

Command	Status	Duration	Result
`nx run-many --target=build --exclude website --...`	✅ Succeeded	2s	View ↗
`nx run-many --target=clean`	✅ Succeeded	10s	View ↗

☁️ Nx Cloud last updated this comment at 2025-04-07 12:12:16 UTC

codecov · 2025-03-14T14:54:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.03%. Comparing base (052b7f9) to head (489037c).
Report is 11 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10950   +/-   ##
=======================================
  Coverage   88.03%   88.03%           
=======================================
  Files         470      470           
  Lines       16801    16805    +4     
  Branches     4745     4747    +2     
=======================================
+ Hits        14790    14794    +4     
  Misses       1664     1664           
  Partials      347      347

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

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

Files with missing lines	Coverage Δ
.../eslint-plugin/src/rules/promise-function-async.ts	`100.00% <100.00%> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

JoshuaKGoldberg

LGTM! Just one suggestion on the phrasing?

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

kirkwaiblinger · 2025-03-18T21:43:42Z

Random thought: Should this be a suggestion instead of an auto-fix in this case?

I personally like the idea of providing two suggestions:

add async (demoted from autofix)
add explicit return type

TBH it's suspect to me that this is ever an autofix rather than a suggestion, since I don't like autofixing runtime behavior changes based on type information, but that's neither here nor there.

JoshuaKGoldberg

👍 My vote: mentioning the type being a union, as Kirk suggested?

Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>

JoshuaKGoldberg

Great! Just pinging @kirkwaiblinger to confirm, this looks lovely to me.

kirkwaiblinger

❤️ 🚀

@kirkwaiblinger

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 | | npm | @typescript-eslint/parser | 8.29.0 | 8.30.1 | ## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14) ##### 🩹 Fixes - **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072)) ##### ❤️ Thank You - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) 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. ## [v8.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14) ##### 🚀 Features - **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950)) ##### ❤️ Thank You - Dima Barabash [@dbarabashh](https://github.com/dbarabashh) - 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. ## [v8.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07) ##### 🩹 Fixes - **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998)) ##### ❤️ Thank You - 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.

@kirkwaiblinger

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 | | npm | @typescript-eslint/parser | 8.29.0 | 8.30.1 | ## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14) ##### 🩹 Fixes - **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072)) ##### ❤️ Thank You - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) 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. ## [v8.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14) ##### 🚀 Features - **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950)) ##### ❤️ Thank You - Dima Barabash [@dbarabashh](https://github.com/dbarabashh) - 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. ## [v8.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07) ##### 🩹 Fixes - **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998)) ##### ❤️ Thank You - 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.

@kirkwaiblinger

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 | | npm | @typescript-eslint/parser | 8.29.0 | 8.30.1 | ## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14) ##### 🩹 Fixes - **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072)) ##### ❤️ Thank You - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) 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. ## [v8.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14) ##### 🚀 Features - **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950)) ##### ❤️ Thank You - Dima Barabash [@dbarabashh](https://github.com/dbarabashh) - 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. ## [v8.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07) ##### 🩹 Fixes - **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998)) ##### ❤️ Thank You - 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.

@kirkwaiblinger

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 | | npm | @typescript-eslint/parser | 8.29.0 | 8.30.1 | ## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14) ##### 🩹 Fixes - **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072)) ##### ❤️ Thank You - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) 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. ## [v8.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14) ##### 🚀 Features - **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950)) ##### ❤️ Thank You - Dima Barabash [@dbarabashh](https://github.com/dbarabashh) - 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. ## [v8.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07) ##### 🩹 Fixes - **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998)) ##### ❤️ Thank You - 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.

ronami added 4 commits March 14, 2025 16:12

initial implementation

b4a53f7

tests

9f2900c

snapshots

db52ca5

cover overloading case

8b51b8d

ronami marked this pull request as ready for review March 14, 2025 14:55

JoshuaKGoldberg previously approved these changes Mar 17, 2025

View reviewed changes

Comment thread packages/eslint-plugin/src/rules/promise-function-async.ts Outdated

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Mar 17, 2025

Update packages/eslint-plugin/src/rules/promise-function-async.ts

9eb0f5b

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

ronami dismissed JoshuaKGoldberg’s stale review via 9eb0f5b March 18, 2025 17:55

snapshots

577b247

kirkwaiblinger reviewed Mar 18, 2025

View reviewed changes

Comment thread packages/eslint-plugin/src/rules/promise-function-async.ts Outdated

JoshuaKGoldberg removed the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Mar 24, 2025

JoshuaKGoldberg requested changes Mar 31, 2025

View reviewed changes

ronami and others added 2 commits April 1, 2025 18:50

Update packages/eslint-plugin/src/rules/promise-function-async.ts

f5b6f75

Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>

snapshots

6831cbf

ronami requested review from JoshuaKGoldberg and kirkwaiblinger April 1, 2025 19:37

github-actions Bot removed the awaiting response Issues waiting for a reply from the OP or another party label Apr 1, 2025

Merge branch 'main' into promise-function-async-mixed-return-type

489037c

JoshuaKGoldberg approved these changes Apr 7, 2025

View reviewed changes

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Apr 7, 2025

kirkwaiblinger approved these changes Apr 14, 2025

View reviewed changes

JoshuaKGoldberg merged commit 128d95b into typescript-eslint:main Apr 14, 2025

ronami deleted the promise-function-async-mixed-return-type branch April 14, 2025 14:07

github-actions Bot locked as resolved and limited conversation to collaborators Apr 22, 2025

Navigation Menu

Repository navigation

fix(eslint-plugin): [promise-function-async] use a different error message for functions with promise and non-promise types - #10950

fix(eslint-plugin): [promise-function-async] use a different error message for functions with promise and non-promise types#10950
JoshuaKGoldberg merged 9 commits into
typescript-eslint:mainfrom
ronami:promise-function-async-mixed-return-type

ronami commented Mar 14, 2025

Uh oh!

typescript-eslint Bot commented Mar 14, 2025

Uh oh!

netlify Bot commented Mar 14, 2025 •

edited

Loading

Uh oh!

nx-cloud Bot commented Mar 14, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Mar 14, 2025 •

edited

Loading

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger commented Mar 18, 2025 •

edited

Loading

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

kirkwaiblinger left a comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ronami commented Mar 14, 2025

PR Checklist

Overview

Uh oh!

typescript-eslint Bot commented Mar 14, 2025

Uh oh!

netlify Bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud Bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

kirkwaiblinger left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify Bot commented Mar 14, 2025 •

edited

Loading

nx-cloud Bot commented Mar 14, 2025 •

edited

Loading

codecov Bot commented Mar 14, 2025 •

edited

Loading

kirkwaiblinger commented Mar 18, 2025 •

edited

Loading