fix!: only require awaiting promises returned from inside try/catch blocks
#133
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… blocks Returning unawaited promises from inside try/catch blocks is usually a bug as the author more than likely intends the catch part to handle errors. The configuration in this PR disallows `await` before `return` unless it is inside a `try/catch` in which case it is required. `await` before `return` doesn't cause any harm but I don't think we can configure the rule any other way. This is a breaking change but one that is fixable with `npm run lint -- --fix` Fixes: #130 BREAKING CHANGE: `await` is not allowed before `return` unless it is inside a `try/catch` in which case it is required
SgtPooki
approved these changes
Mar 13, 2023
achingbrain
added a commit
that referenced
this pull request
Apr 5, 2023
… blocks (#133) Returning unawaited promises from inside try/catch blocks is usually a bug as the author more than likely intends the catch part to handle errors. The configuration in this PR disallows `await` before `return` unless it is inside a `try/catch` in which case it is required. `await` before `return` doesn't cause any harm but I don't think we can configure the rule any other way. This is a breaking change but one that is fixable with `npm run lint -- --fix` Fixes: #130 BREAKING CHANGE: `await` is not allowed before `return` unless it is inside a `try/catch` in which case it is required Co-authored-by: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
github-actions bot
pushed a commit
that referenced
this pull request
Apr 5, 2023
## [4.0.0](v3.1.7...v4.0.0) (2023-04-05) ### ⚠ BREAKING CHANGES * `await` is not allowed before `return` unless it is inside a `try/catch` in which case it is required Co-authored-by: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com> * previously jsx and tsx files were not linted, now they are * add import sorting rule (#126) ### Features * add import sorting rule ([#126](#126)) ([1462d09](1462d09)) * lint jsx ([#140](#140)) ([fb5e5b6](fb5e5b6)) ### Bug Fixes * only require `await`ing promises returned from inside try/catch blocks ([#133](#133)) ([a6e4a7b](a6e4a7b)), closes [#130](#130) ### Trivial Changes * convert to aegir project ([81d8ba3](81d8ba3)) * **deps:** bump eslint-config-standard-with-typescript from 27.0.1 to 34.0.1 ([#135](#135)) ([fc9aa6f](fc9aa6f)) * **deps:** bump eslint-plugin-jsdoc from 39.9.1 to 40.1.1 ([#139](#139)) ([bd1422b](bd1422b)) * fix linting ([adffc58](adffc58)) * use unified ci ([2674c56](2674c56))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Returning unawaited promises from inside try/catch blocks is usually a bug as the author more than likely intends the catch part to handle errors.
The configuration in this PR disallows
awaitbeforereturnunless it is inside atry/catchin which case it is required.awaitbeforereturndoesn't cause any harm but I don't think we can configure the rule any other way.This is a breaking change but one that is fixable with
npm run lint -- --fixFixes: #130
BREAKING CHANGE:
awaitis not allowed beforereturnunless it is inside atry/catchin which case it is required