Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(eslint-plugin): [require-await] treat yield* asynciterable as an await #4125

Conversation

danny-may
Copy link
Contributor

PR Checklist

Overview

The previous implementation specifically only checked for the AsyncGenerator type, however any type that has a [Symbol.asyncIterator] property is closer to what actually happens at runtime. This change checks for the existance of [Symbol.asyncIterator] on any of the types (union or intersection types are checked) and declares await as being called if one exists.

This also fixes a small related issue where yield* <some literal> would cause any previous yield*'s to be ignored, giving a false positive.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @danny-may!

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
Copy link

netlify bot commented Nov 11, 2021

✔️ Deploy Preview for typescript-eslint ready!

🔨 Explore the source changes: 69c34de

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

😎 Browse the preview: https://deploy-preview-4125--typescript-eslint.netlify.app

@bradzacher bradzacher changed the title fix(eslint-plugin): [require-await] treat yield* asynciterable as an … fix(eslint-plugin): [require-await] treat yield* asynciterable as an await Nov 11, 2021
@bradzacher bradzacher added the bug Something isn't working label Nov 11, 2021
@codecov
Copy link

codecov bot commented Nov 11, 2021

Codecov Report

Merging #4125 (69c34de) into master (ae0fb5a) will increase coverage by 0.00%.
The diff coverage is 90.00%.

@@           Coverage Diff           @@
##           master    #4125   +/-   ##
=======================================
  Coverage   93.35%   93.35%           
=======================================
  Files         152      152           
  Lines        8035     8041    +6     
  Branches     2579     2581    +2     
=======================================
+ Hits         7501     7507    +6     
+ Misses        180      179    -1     
- Partials      354      355    +1     
Flag Coverage Δ
unittest 93.35% <90.00%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
packages/eslint-plugin/src/rules/require-await.ts 90.47% <90.00%> (+1.00%) ⬆️

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Agreed with bradzacher, generators + async iterators is such a bizarre topic to get through. Thanks for taking this on @danny-may! ⭐

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[@typescript-eslint/require-await] false positive on async generators without await
3 participants