-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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): [no-unnecessary-type-parameters] should parenthesize type in suggestion fixer if necessary #10907
base: main
Are you sure you want to change the base?
fix(eslint-plugin): [no-unnecessary-type-parameters] should parenthesize type in suggestion fixer if necessary #10907
Conversation
Thanks for the PR, @y-hsgw! 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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
View your CI Pipeline Execution ↗ for commit 8086924.
☁️ Nx Cloud last updated this comment at |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10907 +/- ##
==========================================
+ Coverage 87.43% 87.59% +0.15%
==========================================
Files 468 470 +2
Lines 16040 16101 +61
Branches 4649 4671 +22
==========================================
+ Hits 14025 14103 +78
+ Misses 1658 1642 -16
+ Partials 357 356 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! 👍
Wait, was too optimistic - taking a closer look..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff! I think just a bit of extra testing & code flow trimming are needed now. 🔥
packages/eslint-plugin/src/rules/no-unnecessary-type-parameters.ts
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/tests/rules/no-unnecessary-type-parameters.test.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀 Looks great to me, thanks!
AST_NODE_TYPES.TSIndexedAccessType, | ||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
].some(type => referenceNode.parent.parent!.type === type); | ||
if (isCompositeType && hasMatchingAncestorType) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this logic isn't quite right, in that it's not general enough.... We really want (as close as we can) to answer the question - "is the destination context going to be higher precedence than the source?". This logic only identifies the special case of intersection/union being lower precedence than TSArrayType/TSIndexedAccessType, which is true, but there is much more nuance.
For example, TSIntersectionType
is higher precedence than TSUnionType
, so the following test case currently doesn't work correctly:
type A = string;
type B = string;
type C = string;
declare function f<T extends A | B>(): T & C;
// fixes to
declare function f(): A | B & C;
// (which is equivalent to)
declare function f(): A | (B & C);
// should fix to
declare function f(): (A | B) & C;
Another (quite perverse) test case that isn't currently handled correctly is
type A = string;
type B = string;
type C = string;
type D = string;
declare function f<T extends A extends B ? C : D>(): T | null;
// fixes to
declare function f(): A extends B ? C : D | null;
// (which is equivalent to)
declare function f(): A extends B ? C : (D | null);
// should fix to
declare function f(): (A extends B ? C : D) | null;
Note that it's not necessarily practical to get this 100% correct in all cases, so some extra "unnecessary" parens are totally acceptable here if it the implementation benefits. FWIW - prettier actually puts "unnecessary" parens anyway for the mixed union/intersection case, since it's just hard to read for us humans otherwise 🙃
Have you had a look at the implementations of getWrappingFixer
and friends? I'd think they have some of this logic already implemented more generally?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you. I've added the missing cases and modified it to use getWrappingFixer.
PR Checklist
Overview
Fixed the bug described in the title.
Please note that in addition to the error examples in the #10894, I have also addressed several related cases.
🐛