-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
feat(eslint-plugin): add return-await rule #1050
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
Conversation
Thanks for the PR, @drabinowitz! 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. |
@bradzacher just wanted to check in on this to see if any other info was needed from my end. |
I haven't had a look, sorry - it's in the review queue, so I'll take a look soon. |
Sounds good no rush, just wanted to make sure there wasn't anything missing I needed to take care of before it was eligible for review. |
Codecov Report
@@ Coverage Diff @@
## master #1050 +/- ##
==========================================
+ Coverage 94.2% 94.22% +0.01%
==========================================
Files 128 129 +1
Lines 5561 5611 +50
Branches 1559 1575 +16
==========================================
+ Hits 5239 5287 +48
Misses 180 180
- Partials 142 144 +2
|
@bradzacher i wanted to check in on this pr to see if you'd had a chance to take a look at it. |
I have not yet. My open source time lately has been consumed by fixing the IDE errors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One change, otherwise LGTM
Thanks for this.
docs: { | ||
description: 'Rules for awaiting returned promises', | ||
category: 'Best Practices', | ||
recommended: 'error', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this has to be false
for now.
adding a rule to the recommended config is counted as a breaking change, so it has to wait for a major release.
(don't forget to regen configs after)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will do!
return-await is not a recommended rule for users as part of default typescript-eslint setup. re typescript-eslint#994
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for this
This closes #994 adding the
return-await
rule.