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

fix(eslint-plugin): [prefer-ts-expect-error] support block comments #2541

Merged
merged 5 commits into from Sep 21, 2020

Conversation

@yasarsid
Copy link
Contributor

@yasarsid yasarsid commented Sep 11, 2020

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-ignore and removing a check for block comments.

Additionally, the Rulefixer for single line comments and block comments has a little different behavior.

Checklist

  • Add UTs corresponding to change
  • Change rule documentation corresponding to change
@typescript-eslint
Copy link

@typescript-eslint typescript-eslint bot commented Sep 11, 2020

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

@codecov codecov bot commented Sep 11, 2020

Codecov Report

Merging #2541 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            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     
Flag Coverage Δ
#unittest 92.83% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
.../eslint-plugin/src/rules/prefer-ts-expect-error.ts 100.00% <ø> (ø)
...ackages/eslint-plugin/src/rules/no-implied-eval.ts 93.75% <0.00%> (-2.81%) ⬇️
packages/eslint-plugin/src/rules/return-await.ts 95.69% <0.00%> (-0.08%) ⬇️
packages/experimental-utils/src/ts-eslint/Scope.ts 100.00% <0.00%> (ø)
...es/eslint-plugin/src/rules/no-use-before-define.ts 94.36% <0.00%> (ø)
...kages/eslint-plugin/src/rules/naming-convention.ts 89.30% <0.00%> (+0.14%) ⬆️
packages/eslint-plugin/src/rules/no-unused-vars.ts 93.06% <0.00%> (+0.21%) ⬆️
...es/eslint-plugin/src/rules/prefer-function-type.ts 96.29% <0.00%> (+1.17%) ⬆️
{
/* @ts-expect-error */
}
const value: number = 'value';
/**
* @ts-expect-error
*/
const block: string = 1;
Comment on lines 45 to 53

This comment has been minimized.

@bradzacher

bradzacher Sep 12, 2020
Member

this is not valid code - the expect error does not apply to the next line in either of these cases
repl

This comment has been minimized.

@yasarsid

yasarsid Sep 13, 2020
Author Contributor

Thanks for pointing it out.

I think I got mixed up with the following code repl

/** 
 *  
 * @ts-ignore */
let value: string = 1

Corrected and added additional test cases for the same.

{
/* @ts-ignore */
}
const value: number = 'value';
/**
* @ts-ignore
*/
const block: string = 1;
Comment on lines 23 to 31

This comment has been minimized.

@bradzacher

bradzacher Sep 12, 2020
Member

this is not valid code - the expect error does not apply to the next line in either of these cases
repl

This comment has been minimized.

@yasarsid

yasarsid Sep 13, 2020
Author Contributor

Correct now

@yasarsid yasarsid requested a review from bradzacher Sep 13, 2020
@bradzacher bradzacher changed the title fix(eslint-plugin): Add prefer-ts-expect-error support for block comments fix(eslint-plugin): [prefer-ts-expect-error] support block comments Sep 14, 2020
Yasar Siddiqui
@yasarsid yasarsid requested a review from bradzacher Sep 15, 2020
Copy link
Member

@bradzacher bradzacher left a comment

LGTM - thanks for your contribution

@bradzacher bradzacher merged commit c6f72fb into typescript-eslint:master Sep 21, 2020
10 checks passed
10 checks passed
Typecheck
Details
Unit tests Unit tests
Details
Code style and lint
Details
Run integration tests on primary Node.js version
Details
Run unit tests on other Node.js versions (10.x)
Details
Run unit tests on other Node.js versions (14.x)
Details
Publish the latest code as a canary version
Details
Semantic Pull Request ready to be squashed
Details
codecov/patch Codecov Report
Details
codecov/project Codecov Report
Details
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants