-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
fix(eslint-plugin): [no-deprecated] should allow ignoring of deprecated value #10670
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
base: main
Are you sure you want to change the base?
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 project configuration. |
View your CI Pipeline Execution ↗ for commit 8ef57d2.
☁️ 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 #10670 +/- ##
==========================================
+ Coverage 90.92% 90.93% +0.01%
==========================================
Files 499 499
Lines 50845 50904 +59
Branches 8384 8404 +20
==========================================
+ Hits 46231 46290 +59
Misses 4599 4599
Partials 15 15
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.
✨
Whoops, wrong button, sorry for the noise :)
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 for sending this in! 💪
Codecov is right to report, we have tests set up in packages/type-utils
to make sure these utils are fully unit tested. Could you please add tests to TypeOrValueSpecifier.test.ts
?
All three of the specifier sources formats should be tested: file, lib, and package.
I've added the tests! |
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.
Do you think it might be necessary to verify whether it is imported from a package?
Indeed I do - the goal of the shared format is to match on both the name and where a type/value is declared.
Thanks!
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.
A bit more complication! 🚀
I'm also starting to wonder - maybe it makes sense to unify the typeMatchesSpecifier
and valueMatchesSpecifier
logic? If the value checking needs type information anyway...
): boolean { | ||
if ( | ||
node.type === AST_NODE_TYPES.Identifier || | ||
node.type === AST_NODE_TYPES.JSXIdentifier |
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.
[Bug] This works for the two specified types of identifiers, but there are other things out there. Private properties, computed keys based on string literals, etc. - which should be tested.
I think you'll want to use getStaticValue
to get the static value. getStaticMemberAccessValue
in eslint-plugin
might be useful as a reference as well, not sure.
Btw, sorry, I realize I suggested these two checks in #10670 (comment) and now am kind of going against that. If this utility were only used internally and by no-deprecated
that'd be fine. But I'm remembering now that this is also exported publicly under @typescript-eslint/type-utils
. We'll need it to be more generalized.
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 for the feedback!
I think Private properties could be supported by 3b3520b.
However, I don't quite understand the support for computed keys. Could you please provide more information?
My understanding is that for cases where AST_NODE_TYPES.Property
is passed as the first argument to valueMatchesSpecifier
, and the key is a computed key, we should handle it in that context. Is that correct?
(I was under the impression that an AST_NODE_TYPES.Identifier
within AST_NODE_TYPES.Property
would be passed as an argument...)
If possible, it would be very helpful if you could provide some concrete test cases or examples to guide the implementation.🙇♂️
I would appreciate it if you could teach me for my learning. (Also for the future!😂)
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 appreciate the questions! Here's a test case I was thinking of:
[
`
class MyClass {
['computed prop'] = 42;
value = this['computed prop'];
}`,
`'computed prop'`,
],
...but now I'm not so sure. We don't have existing code paths for this, and I'm not sure how we'd want to handle differences in quotes ('computed prop'
vs. "computed prop"
). cc @typescript-eslint/triage-team - for now I think it's fine to avoid those types of keys, and treat them as a followup issue?
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 handling the computed properties quotations' on the code side isn't scary due to node.value
being the "cooked" value (and also we have the static member access helpers), but yeah it requires a syntax decision in the selector. If privateProp
matches this.#privateProp
then maybe multi word prop
should match this['multi word prop']
without any extra syntax? Similarly that would sort of imply that aProp
would match this['aProp']
in addition to this.aProp
... which seems reasonable?
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 for the advice.
I’ve added support for the literal case in 0e61bcf — I’d appreciate it if you could take a look!
if (specifier.from === 'package') { | ||
const variable = scopeManager.variables.find(v => v.name === node.name); | ||
const targetNode = variable?.defs[0].parent; | ||
if (targetNode?.type !== AST_NODE_TYPES.ImportDeclaration) { |
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.
[Bug] What if the variable comes from a dynamic package import?
declare const fs: typeof import("fs");
fs.exists;
// ~~~~~~
Using the scope manager to get to the variable's local definition is one step. You might be able to get this to work with more AST+scope work. Or maybe it'd be easier to use TypeScript types and/or symbols? Or some combination of them? YMMV.
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’ve added support for the dynamic import case as well.1578137
PR Checklist
Overview
I have created a
valueMatchesSomeSpecifier
function to check if a value matches the specified specifiers. However, this implementation might only cover the specific case related to the bug in this issue.If you have any advice or suggestions, please feel free to share.
💪