feat(eslint-plugin): [await-thenable] report unnecessary `await using` statements #10209

kirkwaiblinger · 2024-10-26T18:53:43Z

PR Checklist

Addresses an existing open issue: fixes part of Enhancement: [await-thenable] should prohibit using a sync disposable with await using #10208
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Basically just checks whether the RHS of an await using statement might have a [Symbol.asyncDispose](), otherwise reports.

Added in docs and a couple minor refactors. Also modified the getFixOrSuggest() method to allow providing no fix or suggestion.

typescript-eslint · 2024-10-26T18:53:47Z

Thanks for the PR, @kirkwaiblinger!

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-26T18:54:01Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`dc463aa`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6728f84b5e8ecf0008cb013c
😎 Deploy Preview	https://deploy-preview-10209--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 97 (🔴 down 2 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-26T18:54:35Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit dc463aa. 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 30 targets

Sent with 💌 from NxCloud.

packages/eslint-plugin/tests/rules/await-thenable.test.ts

codecov · 2024-10-26T19:18:12Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.52%. Comparing base (099fd4c) to head (dc463aa).
Report is 28 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10209      +/-   ##
==========================================
+ Coverage   86.51%   86.52%   +0.01%     
==========================================
  Files         430      430              
  Lines       15098    15142      +44     
  Branches     4384     4405      +21     
==========================================
+ Hits        13062    13102      +40     
- Misses       1679     1683       +4     
  Partials      357      357

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

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

Files with missing lines	Coverage Δ
packages/eslint-plugin/src/rules/await-thenable.ts	`100.00% <100.00%> (ø)`
.../rules/prefer-optional-chain-utils/analyzeChain.ts	`100.00% <100.00%> (ø)`
packages/eslint-plugin/src/rules/return-await.ts	`97.43% <100.00%> (+0.02%)`	⬆️
packages/eslint-plugin/src/util/getFixOrSuggest.ts	`100.00% <100.00%> (ø)`

... and 9 files with indirect coverage changes

packages/eslint-plugin/src/rules/await-thenable.ts

JoshuaKGoldberg

Clever, I like how the getFixOrSuggest change fits in!

Just requesting changes on the docs, WDYT?

packages/eslint-plugin/tests/docs.test.ts

packages/eslint-plugin/tests/rules/await-thenable.test.ts

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

JoshuaKGoldberg

🙌

@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.

[await-thenable] report unnecessary await using statements

806ac11

kirkwaiblinger commented Oct 26, 2024

View reviewed changes

packages/eslint-plugin/tests/rules/await-thenable.test.ts Show resolved Hide resolved

continue, not return

660f810

kirkwaiblinger commented Oct 26, 2024

View reviewed changes

packages/eslint-plugin/src/rules/await-thenable.ts Outdated Show resolved Hide resolved

kirkwaiblinger mentioned this pull request Oct 26, 2024

Enhancement: [await-thenable] should prohibit using a sync disposable with await using #10208

Closed

4 tasks

await using without init

ea8339a

kirkwaiblinger marked this pull request as ready for review October 27, 2024 07:08

kirkwaiblinger added 2 commits October 27, 2024 11:38

disable lint error

80f159c

Merge branch 'main' into await-thenable-await-using

969e09d

JoshuaKGoldberg requested changes Nov 4, 2024

View reviewed changes

packages/eslint-plugin/tests/docs.test.ts Outdated Show resolved Hide resolved

packages/eslint-plugin/tests/rules/await-thenable.test.ts Show resolved Hide resolved

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

exempt code ticks from upper-case heading test

dc463aa

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

JoshuaKGoldberg approved these changes Nov 4, 2024

View reviewed changes

JoshuaKGoldberg merged commit 5b2ebcd into typescript-eslint:main Nov 4, 2024
60 of 62 checks passed

kirkwaiblinger deleted the await-thenable-await-using branch November 4, 2024 22:33

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [await-thenable] report unnecessary `await using` statements #10209

feat(eslint-plugin): [await-thenable] report unnecessary `await using` statements #10209

kirkwaiblinger commented Oct 26, 2024

typescript-eslint bot commented Oct 26, 2024

netlify bot commented Oct 26, 2024 •

edited

Loading

nx-cloud bot commented Oct 26, 2024 •

edited

Loading

codecov bot commented Oct 26, 2024 •

edited

Loading

JoshuaKGoldberg left a comment

JoshuaKGoldberg left a comment

feat(eslint-plugin): [await-thenable] report unnecessary await using statements #10209

feat(eslint-plugin): [await-thenable] report unnecessary await using statements #10209

Conversation

kirkwaiblinger commented Oct 26, 2024

PR Checklist

Overview

typescript-eslint bot commented Oct 26, 2024

netlify bot commented Oct 26, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

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

☁️ Nx Cloud Report

codecov bot commented Oct 26, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

feat(eslint-plugin): [await-thenable] report unnecessary `await using` statements #10209

feat(eslint-plugin): [await-thenable] report unnecessary `await using` statements #10209

netlify bot commented Oct 26, 2024 •

edited

Loading

nx-cloud bot commented Oct 26, 2024 •

edited

Loading

codecov bot commented Oct 26, 2024 •

edited

Loading