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-types] allow banning types with specific parameters #2662


Copy link

@binoche9 binoche9 commented Oct 10, 2020

Fixes #2657.

The docs for ban-types claims that ban-types can be used with "a type name with generic parameter instantiation(s)", but this functionality never seems to have been implemented. The previous implementation only compared against the typeName node of the type reference, but now we also compare against the entire TypeReference node if there are any type parameters.

Copy link

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

Thanks for the PR, @binoche9!

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 10, 2020

Codecov Report

Merging #2662 into master will increase coverage by 0.04%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #2662      +/-   ##
+ Coverage   92.80%   92.85%   +0.04%     
  Files         293      294       +1     
  Lines        9604     9666      +62     
  Branches     2711     2712       +1     
+ Hits         8913     8975      +62     
  Misses        326      326              
  Partials      365      365              
Flag Coverage Δ
#unittest 92.85% <100.00%> (+0.04%) ⬆️

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

Impacted Files Coverage Δ
packages/eslint-plugin/src/rules/ban-types.ts 100.00% <100.00%> (ø)
packages/scope-manager/src/lib/index.ts 100.00% <0.00%> (ø)
@bradzacher bradzacher added the bug label Oct 11, 2020
Copy link

@bradzacher bradzacher left a comment

nice and simple - thanks for fixing this!

@bradzacher bradzacher changed the title fix(eslint-plugin): [ban-types] Allow banning type parameters fix(eslint-plugin): [ban-types] allow banning types with specific parameters Oct 11, 2020
@bradzacher bradzacher merged commit 77732a2 into typescript-eslint:master Oct 11, 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.85% (+0.04%) compared to 03886d7
Copy link
Contributor Author

@binoche9 binoche9 commented Oct 12, 2020

My first open-source contribution 🎉 Feels good 😁

@binoche9 binoche9 deleted the binoche9:binoche9/ban-types-type-parameter-2657 branch Oct 12, 2020
@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.

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