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

feat(eslint-plugin): add return-await rule #1050

Merged
merged 24 commits into from
Nov 25, 2019

Conversation

drabinowitz
Copy link
Contributor

This closes #994 adding the return-await rule.

@typescript-eslint
Copy link
Contributor

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 bradzacher added the enhancement: new plugin rule New rule request for eslint-plugin label Oct 8, 2019
@bradzacher bradzacher changed the title feat(eslint-plugin): add return-await rule (#994) feat(eslint-plugin): add return-await rule Oct 8, 2019
@drabinowitz
Copy link
Contributor Author

@bradzacher just wanted to check in on this to see if any other info was needed from my end.

@bradzacher
Copy link
Member

I haven't had a look, sorry - it's in the review queue, so I'll take a look soon.

@drabinowitz
Copy link
Contributor Author

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

codecov bot commented Oct 17, 2019

Codecov Report

Merging #1050 into master will increase coverage by 0.01%.
The diff coverage is 96.22%.

@@            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
Impacted Files Coverage Δ
packages/eslint-plugin/src/rules/index.ts 100% <100%> (ø) ⬆️
packages/eslint-plugin/src/rules/return-await.ts 95.91% <95.91%> (ø)

@drabinowitz
Copy link
Contributor Author

@bradzacher i wanted to check in on this pr to see if you'd had a chance to take a look at it.

@bradzacher
Copy link
Member

I have not yet. My open source time lately has been consumed by fixing the IDE errors.
It's on the list of PRs to review.

Copy link
Member

@bradzacher bradzacher left a 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',
Copy link
Member

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)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will do!

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Nov 22, 2019
Copy link
Member

@bradzacher bradzacher 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 for this

@bradzacher bradzacher added 1 approval One team member has approved this PR; a second should be enough to merge it and removed awaiting response Issues waiting for a reply from the OP or another party labels Nov 25, 2019
@bradzacher bradzacher merged commit 0ff4620 into typescript-eslint:master Nov 25, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval One team member has approved this PR; a second should be enough to merge it enhancement: new plugin rule New rule request for eslint-plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request - rule for await in async try catch return
2 participants