typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.8k

fix(eslint-plugin): [no-misused-promises] check contextual type#10042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

JoshuaKGoldberg merged 4 commits intotypescript-eslint:mainfromyeonjuan:fix/8054

Sep 29, 2024

Merged

fix(eslint-plugin): [no-misused-promises] check contextual type#10042

JoshuaKGoldberg merged 4 commits intotypescript-eslint:mainfromyeonjuan:fix/8054

Sep 29, 2024

Conversation

Copy link

Contributor

yeonjuan commentedSep 23, 2024

PR Checklist

Addresses an existing open issue:fixesBug: no-misused-promises ignores conversion of Promise to void for generic higher-order-functions with fixed type parameter #8054
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

fix(eslint-plugin): [no-misused-promises] check contextual type

b8e5d46

Copy link

Contributor

typescript-eslintbot commentedSep 23, 2024

Thanks for the PR,@yeonjuan!

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.

Copy link

netlifybot commentedSep 23, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`107a125`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/66f419a948b62e0008620a61
😎 Deploy Preview	https://deploy-preview-10042--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 96 (🔴 down 3 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 90 (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 yourNetlify site configuration.

Copy link

nx-cloudbot commentedSep 23, 2024•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit107a125. 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 💌 fromNxCloud.

fix

05534ce

Copy link

codecovbot commentedSep 23, 2024•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.73%. Comparing base(385bedb) to head(107a125).
Report is 27 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@##             main   #10042      +/-   ##==========================================+ Coverage   88.69%   88.73%   +0.04%==========================================  Files         426      426                Lines       14829    14884      +55       Branches     4313     4328      +15     ==========================================+ Hits        13153    13208      +55- Misses       1533     1534       +1+ Partials      143      142       -1

Flag	Coverage Δ
unittest	`88.73% <100.00%> (+0.04%)`	⬆️

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	`98.83% <100.00%> (+0.01%)`	⬆️

... and13 files with indirect coverage changes

auvred requested changes

Sep 25, 2024

View reviewed changes

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

Comment on lines 829 to 842

		const contextualType = checker.getContextualTypeForArgumentAtIndex(
		node,
		index,
		);
		if (contextualType !== type) {
		checkThenableOrVoidArgument(
		checker,
		node,
		contextualType,
		index,
		thenableReturnIndices,
		voidReturnIndices,
		);
		}

Copy link

Member

Choose a reason for hiding this comment

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

[Bug] We should also do this both for arrays and tuples

declarefunctionfn<Textends(...args:unknown[])=>unknown>(fn:T):voidfn<()=>void>(async()=>{});// reported - okdeclarefunctiontupleFn<Textends(...args:unknown[])=>unknown>(...fns:[T,string,T]):voidtupleFn<()=>void>(async()=>{},'foo',async()=>{});// not reported - bugdeclarefunctionarrayFn<Textends(...args:unknown[])=>unknown>(...fns:(T|string)[]):voidarrayFn<()=>void>(async()=>{},'foo',async()=>{});// not reported - bug

playground link

Copy link

ContributorAuthor

Choose a reason for hiding this comment

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

@auvred Thanks for the detailed examples. fixed707d787

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

		fn: T,
		) => T;
		declare const useCallbackReturningVoid: typeof useCallback<ReturnsVoid>;
		useCallbackReturningVoid(async () => {}); // correct

Copy link

Member

Choose a reason for hiding this comment

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

Suggested change

	useCallbackReturningVoid(async()=>{});// correct
	useCallbackReturningVoid(async()=>{});

nit :)

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

Sep 25, 2024

yeonjuan added2 commits

September 25, 2024 23:08

apply review

707d787

remove comment

107a125

auvred approved these changes

Sep 29, 2024

View reviewed changes

Copy link

Member

auvred left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

auvred added 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge and removed awaiting responseIssues waiting for a reply from the OP or another party labels

Sep 29, 2024