typescript-eslint/typescript-eslintPublic

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

feat(eslint-plugin): [return-await] promote to recommended: strict#9595

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

Closed

JoshuaKGoldberg wants to merge1 commit intotypescript-eslint:v8fromJoshuaKGoldberg:return-await-recommended-strict

Closed

feat(eslint-plugin): [return-await] promote to recommended: strict#9595

JoshuaKGoldberg wants to merge1 commit intotypescript-eslint:v8fromJoshuaKGoldberg:return-await-recommended-strict

Conversation

Copy link

Member

JoshuaKGoldberg commentedJul 19, 2024

PR Checklist

Addresses an existing open issue:fixesConfigs: includereturn-await instrict-type-checked preset #8667
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

Addsreturn-await to thestrict-type-checked preset shared config.

This is not a breaking change, asstrict configs are explicitly allowed to be modified in minor versions. But targeting tov8 to be friendly.

💖

feat(eslint-plugin): [return-await] promote to recommended: strict

e450e75

Copy link

Contributor

typescript-eslintbot commentedJul 19, 2024

Thanks for the PR,@JoshuaKGoldberg!

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 commentedJul 19, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`e450e75`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/669a8250dd08c00008056750
😎 Deploy Preview	https://deploy-preview-9595--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: 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 commentedJul 19, 2024•
edited
Loading

☁️ Nx Cloud Report

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

🟥 Failed Commands
`nx run-many --target=lint --parallel --exclude eslint-plugin`

✅ Successfully ran 30 targets

Sent with 💌 fromNxCloud.

JoshuaKGoldberg requested review froma team andkirkwaiblinger

July 19, 2024 15:20

JoshuaKGoldberg marked this pull request as ready for review

July 19, 2024 15:20

JoshuaKGoldberg commented

Jul 19, 2024

View reviewed changes

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

		meta:{
		docs:{
		description:'Enforce consistent awaiting of returned promises',
		recommended:'strict',

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

@kirkwaiblinger surfacing what you mentioned a bit back in a DM: that we might want to customize settings for this rule in the strict configs. I'm interpreting#8667 (comment) to mean that:

Forstrict: we wantin-type-checked, as it avoids stylistic things
Forstylistic: that'd be a separate issue

...and since this already hasdefaultOptions: ['in-try-catch'], we're cleared to just sayrecommended: 'strict'. Is that right?

Copy link

Member

kirkwaiblingerJul 19, 2024•
edited
Loading

Choose a reason for hiding this comment

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

negative - my understanding was that the only thing that we are currently proceeding with is puttingreturn-await in thestrict configwith optionerror-handling-correctness-only.

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

Right! Makes sense, thanks.

Since that's a little bit more plumbing, as you suggested it would be, I'm going to close this one out & let you take lead. You've already taken the lead on so much around it & other async things, I'd rather not butt in.