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): [ban-ts-comment] support block comments #2644

merged 12 commits into from Oct 12, 2020


Copy link

@dopecodez dopecodez commented Oct 7, 2020

Fixes #2617


The support for ban-ts-comment was restricted to only single line comments.

This PR looks to expand the support for ban-ts-comment for block comments also.


The approach revolved around changing the regex for recognizing the valid cases of @ts- commands and also changing how we handled comparing this regex and our comment.


  • Add UTs corresponding to change
  • Change rule documentation corresponding to change
Copy link

@typescript-eslint typescript-eslint bot commented Oct 7, 2020

Thanks for the PR, @dopecodez!

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 As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

Copy link

@codecov codecov bot commented Oct 7, 2020

Codecov Report

Merging #2644 into master will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #2644      +/-   ##
+ Coverage   92.80%   92.83%   +0.03%     
  Files         293      294       +1     
  Lines        9604     9674      +70     
  Branches     2711     2713       +2     
+ Hits         8913     8981      +68     
- Misses        326      327       +1     
- Partials      365      366       +1     
Flag Coverage Δ
#unittest 92.83% <100.00%> (+0.03%) ⬆️

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

Impacted Files Coverage Δ
packages/eslint-plugin/src/rules/ban-ts-comment.ts 95.65% <100.00%> (+0.19%) ⬆️ 92.50% <0.00%> (-1.87%) ⬇️
packages/scope-manager/src/lib/index.ts 100.00% <0.00%> (ø)
@bradzacher bradzacher changed the title bug(eslint-plugin): support block comments for ban-ts-comment rule in eslint-plugin fix(eslint-plugin): [ban-ts-comment] support block comments Oct 7, 2020
@bradzacher bradzacher added the bug label Oct 7, 2020
dopecodez added 2 commits Oct 8, 2020
Copy link
Contributor Author

@dopecodez dopecodez commented Oct 9, 2020

@bradzacher , I can see codecov not returning a status for my newest commit, and also can see the same happening to another PR.
Looks like this is a known problem.
The only way around it is to make a commit right now, since i can't retrigger the codecov report for this project. Could be something to take a look at in the future.

Copy link

@bradzacher bradzacher commented Oct 9, 2020

codecov is average yeah. sometimes it doesn't work. sometimes it's kinda flaky. it's also just slow sometimes.
it looks like it's reported the status now.

dopecodez and others added 3 commits Oct 9, 2020
Copy link

@bradzacher bradzacher left a comment

lgtm - thanks for your contribution!

@bradzacher bradzacher merged commit 9c3c686 into typescript-eslint:master Oct 12, 2020
10 checks passed
10 checks passed
Unit tests Unit tests
Code style and lint
Run integration tests on primary Node.js version
Run unit tests on other Node.js versions (10.x)
Run unit tests on other Node.js versions (14.x)
Publish the latest code as a canary version
Semantic Pull Request ready to be squashed
codecov/patch 100.00% of diff hit (target 90.00%)
codecov/project 92.83% (+0.03%) compared to 03886d7
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 12, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants
You can’t perform that action at this time.