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

feat(eslint-plugin): add rule ban-tslint-comment #2140

Merged
merged 14 commits into from Jun 7, 2020
Merged

feat(eslint-plugin): add rule ban-tslint-comment #2140

merged 14 commits into from Jun 7, 2020

Conversation

drewwyatt
Copy link
Contributor

@drewwyatt drewwyatt commented May 31, 2020

When migrating from tslint to eslint it's probably somewhat common to have leftover tslint rule flags. This rule aims to help clean those up.

Edit: Apologies for the force-push (I know the CONTRIBUTING guide says to try not to do that). My first commit message was incorrect, hopefully since this wasn't a code change it is okay. 🙏

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @drewwyatt!

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.

@drewwyatt drewwyatt changed the title feat(eslint-plugin): add ban-eslint-comment rule feat(eslint-plugin): add ban-tslint-comment rule May 31, 2020
@codecov
Copy link

codecov bot commented May 31, 2020

Codecov Report

Merging #2140 into master will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #2140      +/-   ##
==========================================
+ Coverage   93.44%   93.45%   +0.01%     
==========================================
  Files         171      172       +1     
  Lines        7821     7838      +17     
  Branches     2229     2232       +3     
==========================================
+ Hits         7308     7325      +17     
  Misses        245      245              
  Partials      268      268              
Flag Coverage Δ
#unittest 93.45% <100.00%> (+0.01%) ⬆️
Impacted Files Coverage Δ
packages/eslint-plugin/src/configs/all.ts 100.00% <ø> (ø)
...ages/eslint-plugin/src/rules/ban-tslint-comment.ts 100.00% <100.00%> (ø)

@drewwyatt
Copy link
Contributor Author

Is there anything I can/should do re: codecov failure?

@bradzacher bradzacher added awaiting response Issues waiting for a reply from the OP or another party enhancement: new plugin rule New rule request for eslint-plugin labels May 31, 2020
@drewwyatt
Copy link
Contributor Author

@bradzacher updated. thanks for the feedback!

@bradzacher bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label May 31, 2020
@drewwyatt
Copy link
Contributor Author

@bradzacher is there anything this still needs for you to be able to resolve the change request?

@bradzacher
Copy link
Member

Nothing you need to do - it's in the review queue.

I usually get around to reviews on the weekend 😄

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Jun 6, 2020
@bradzacher
Copy link
Member

one last question before merge

Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for your work!

@bradzacher bradzacher changed the title feat(eslint-plugin): add ban-tslint-comment rule feat(eslint-plugin): add rule ban-tslint-comment Jun 7, 2020
@bradzacher bradzacher merged commit 43ee226 into typescript-eslint:master Jun 7, 2020
@bradzacher bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label Jun 7, 2020
@dimitropoulos
Copy link
Contributor

is there any interest in making this a default (well, "recommended") rule in 4.0? if so I can make an issue

@bradzacher
Copy link
Member

I'd love to for sure, but many of our users are still transitioning from tslint via our eslint-plugin-tslint, so recommending this rule would cause them a lot of frustration.

@drewwyatt
Copy link
Contributor Author

drewwyatt commented Jun 12, 2020

@bradzacher @dimitropoulos Could it make sense to recommend as a warning? I get that it can be a lot, but the transition from tslint for our team is what led to wanting to add the rule in the first place.

@bradzacher
Copy link
Member

I definitely think this rule has value, and eventually I'd love to add it to recommended.

But right now there are a non-trivial number of users using tslint (~3.2m weekly downloads, compared to our ~5.2m and typescript's ~11.9m), so I think it's too early to be forcing this on users. Ideally I'd be looking for the download counts to be ~10% of the ecosystem before I turn it on.

We'll have to do a 4.0 a lot faster than we did a 3.0 due to #2204, so it definitely won't be in 4.0

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement: new plugin rule New rule request for eslint-plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants