fix(eslint-plugin): [return-await] clean up in-try-catch detection and make autofixes safe #9031
Conversation
…ake autofixes safe
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| }, | ||
| ], | ||
| }, | ||
| { | ||
| code: ` | ||
| async function bar() {} |
There was a problem hiding this comment.
This just tests 3 totally separable errors, so I broke it up into 3 separate tests.
| }); | ||
| } else if (!isAwait && isInTryCatch) { | ||
| if (inCatch(expression) && !hasFinallyBlock(expression)) { | ||
| return; |
There was a problem hiding this comment.
| @@ -222,13 +250,29 @@ export default createRule({ | |||
| return; | |||
| } | |||
|
|
|||
| const affectsErrorHandling = affectsExplicitErrorHandling(expression); | |||
There was a problem hiding this comment.
This is excellent work, nicely done @kirkwaiblinger. I tried a few times to find something major to complain about but couldn't find anything. 👏
From me, there's just the one nit on a thrown error. Since this is a pretty tricky area I'll slap on the 1 approval label in the hopes someone else will be able to review too.
✨
| | { fix: TSESLint.ReportFixFunction } | ||
| | { suggest: TSESLint.SuggestionReportDescriptor<MessageId>[] } { | ||
| return useFix ? { fix: suggestion.fix } : { suggest: [suggestion] }; | ||
| } |
There was a problem hiding this comment.
[Praise] I like this :)
|
2619c3b
into
typescript-eslint:main
PR Checklist
Overview
These 3 bugs are closely related, and the code is largely interdependent, so I figured it would be easiest to group into 1 PR. We can do sequential PRs instead if need be.
The diff looks like there's a lot going on, but I think it's actually not so bad, if we go step-by-step. (Then again, this is all swimming around in my head so it probably makes more sense to me than to a reader):
try,catch, orfinally, we now just find the nearesttry-catch-finallystatement and work from there, rather than checking each ancestor separately. (bye-byeinTry,inCatch,hasFinallyBlock,isReturnPromiseInFinally, all replaced byfindEnclosingTryStatement)in-try-catchinto a helper function that now also checks nestedtry-catch-finallystatements, rather than just the closest one found (affectsExplicitErrorHandling), fixing Bug: [return-await] should handle nested try-catch-finally blocks with "in-try-catch" option #8907.in-try-catchthanks to the above helper, fixing Bug: [return-await] awaited promise allowed in terminal catch block #8663.in-try-catchoption as well, as the condition for whether to autofix or suggest a fix, fixing Bug: [return-await] unsafe autofixes in error handling code #8661.try-catch-finallys (Bug: [return-await] should handle nested try-catch-finally blocks with "in-try-catch" option #8907)