fix(eslint-plugin): [prefer-ts-expect-error] support block comments #2541
Conversation
|
Thanks for the PR, @yasarsid! 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. |
Codecov Report
@@ Coverage Diff @@
## master #2541 +/- ##
==========================================
+ Coverage 92.81% 92.83% +0.01%
==========================================
Files 290 290
Lines 9453 9516 +63
Branches 2647 2666 +19
==========================================
+ Hits 8774 8834 +60
- Misses 322 323 +1
- Partials 357 359 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
|
| { | ||
| /* @ts-expect-error */ | ||
| } | ||
| const value: number = 'value'; | ||
|
|
||
| /** | ||
| * @ts-expect-error | ||
| */ | ||
| const block: string = 1; |
There was a problem hiding this comment.
this is not valid code - the expect error does not apply to the next line in either of these cases
repl
There was a problem hiding this comment.
Thanks for pointing it out.
I think I got mixed up with the following code repl
/**
*
* @ts-ignore */
let value: string = 1Corrected and added additional test cases for the same.
| { | ||
| /* @ts-ignore */ | ||
| } | ||
| const value: number = 'value'; | ||
|
|
||
| /** | ||
| * @ts-ignore | ||
| */ | ||
| const block: string = 1; |
There was a problem hiding this comment.
this is not valid code - the expect error does not apply to the next line in either of these cases
repl
Fixes #2531
Overview
The support for prefer-ts-expect-error was restricted to only single line comments.
This PR looks to expand the support for prefer-ts-expect-error for block comments also.
Approach
The approach revolved around changing the regex for recognizing the valid cases of
@ts-ignoreand removing a check for block comments.Additionally, the
Rulefixerfor single line comments and block comments has a little different behavior.Checklist