Skip to content

feat(eslint-plugin): [ban-ts-comments] add "allow-with-description" option #2099

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
May 30, 2020
Merged

feat(eslint-plugin): [ban-ts-comments] add "allow-with-description" option #2099

merged 8 commits into from
May 30, 2020

Conversation

dimitropoulos
Copy link
Contributor

closes #2093

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @dimitropoulos!

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.

@dimitropoulos dimitropoulos changed the title adds "allow-with-description" option to ban-ts-comments rule feat: adds "allow-with-description" option to ban-ts-comments rule May 25, 2020
@dimitropoulos dimitropoulos mentioned this pull request May 25, 2020
Closed
@codecov
Copy link

codecov bot commented May 25, 2020 •
edited
Loading

Codecov Report

Merging #2099 into master will decrease coverage by 0.00%.
The diff coverage is 90.90%.

@@            Coverage Diff             @@
##           master    #2099      +/-   ##
==========================================
- Coverage   93.42%   93.41%   -0.01%     
==========================================
  Files         171      171              
  Lines        7755     7763       +8     
  Branches     2215     2219       +4     
==========================================
+ Hits         7245     7252       +7     
- Misses        244      245       +1     
  Partials      266      266
Flag Coverage Δ
#unittest 93.41% <90.90%> (-0.01%) ⬇️
Impacted Files Coverage Δ
packages/eslint-plugin/src/rules/ban-ts-comment.ts 95.65% <90.90%> (-4.35%) ⬇️

@dimitropoulos
Copy link
Contributor Author

once this merges, I'm happy to do a follow-up PR where I change the default (since that will have to wait in the PR until 4.0 happens)

@dimitropoulos dimitropoulos changed the title feat: adds "allow-with-description" option to ban-ts-comments rule feat(eslint-plugin): adds "allow-with-description" option to ban-ts-comments rule May 25, 2020
@bradzacher bradzacher added the enhancement: plugin rule option New rule option for an existing eslint-plugin rule label May 25, 2020
@bradzacher bradzacher changed the title feat(eslint-plugin): adds "allow-with-description" option to ban-ts-comments rule feat(eslint-plugin): [ban-ts-comments] add "allow-with-description" option May 25, 2020
@dimitropoulos dimitropoulos force-pushed the ts-comment-description branch from f80ba23 to a4b99d7 Compare May 26, 2020 12:39
bradzacher
bradzacher requested changes May 26, 2020
View reviewed changes
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.

pretty straightforward! Thanks for doing this
A few comments

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label May 26, 2020
@dimitropoulos dimitropoulos requested a review from bradzacher May 26, 2020 21:37
@bradzacher bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label May 27, 2020
bradzacher
bradzacher approved these changes May 30, 2020
View reviewed changes
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.

LGTM - thanks for your work!

@bradzacher bradzacher merged commit 8a0fd18 into typescript-eslint:master May 30, 2020
@dimitropoulos dimitropoulos deleted the ts-comment-description branch May 31, 2020 02:21
@dimitropoulos
Copy link
Contributor Author

great! @bradzacher would now(ish) be a good time to make the (breaking change) PR that sets this option on by default for whenever 4.0 happens?

@bradzacher
Copy link
Member

I think just raise an issue for now, we can tag it and create a milestone to track 4.0 like we did for 3.0. Saves having a PR open for months to rebase :)

@dimitropoulos dimitropoulos mentioned this pull request Jun 1, 2020
Closed
@dimitropoulos dimitropoulos mentioned this pull request Jun 1, 2020
Closed
isilher
isilher reviewed Jun 3, 2020
View reviewed changes
Copy link

@isilher isilher left a comment

Choose a reason for hiding this comment

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

Cool! I'm going to add that shiny new allow-with-description setting 🤩

@dimitropoulos dimitropoulos mentioned this pull request Jun 9, 2020
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@isilher isilher isilher left review comments

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
enhancement: plugin rule option New rule option for an existing eslint-plugin rule
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[ban-ts-comment] add option to allow a ts-comment if there is a description with it
3 participants
@dimitropoulos @bradzacher @isilher