Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

Open
wants to merge 26 commits into
base: main
Choose a base branch
from

Conversation

y-hsgw
Copy link
Contributor

@y-hsgw y-hsgw commented Jan 17, 2025

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.

💪

@typescript-eslint
Copy link
Contributor

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.

Copy link

netlify bot commented Jan 17, 2025

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 8ef57d2
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/6827475f1f24fe0008ba2547
😎 Deploy Preview https://deploy-preview-10670--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

nx-cloud bot commented Jan 17, 2025

View your CI Pipeline Execution ↗ for commit 8ef57d2.

Command Status Duration Result
nx test eslint-plugin ✅ Succeeded 6m 14s View ↗
nx run eslint-plugin:test -- --coverage ✅ Succeeded 6m 34s View ↗
nx test eslint-plugin --coverage=false ✅ Succeeded 5m 7s View ↗
nx test rule-tester ✅ Succeeded 1s View ↗
nx run types:build ✅ Succeeded 1s View ↗
nx test typescript-estree ✅ Succeeded 1s View ↗
nx typecheck ast-spec ✅ Succeeded 2s View ↗
nx test scope-manager ✅ Succeeded 1s View ↗
Additional runs (26) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-05-16 14:24:44 UTC

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.93%. Comparing base (f06fd3e) to head (8ef57d2).
Report is 4 commits behind head on main.

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              
Flag Coverage Δ
unittest 90.93% <100.00%> (+0.01%) ⬆️

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

Files with missing lines Coverage Δ
packages/eslint-plugin/src/rules/no-deprecated.ts 96.98% <100.00%> (+0.02%) ⬆️
packages/type-utils/src/TypeOrValueSpecifier.ts 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

@JoshuaKGoldberg JoshuaKGoldberg dismissed their stale review January 17, 2025 13:06

Whoops, wrong button, sorry for the noise :)

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg 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 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.

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Jan 23, 2025
@y-hsgw
Copy link
Contributor Author

y-hsgw commented Jan 25, 2025

I've added the tests!
Is the behavior of valueMatchesSpecifier as expected when specifier.from is set to package?
I would appreciate it if you could verify whether the logic of valueMatchesSpecifier itself is correct. 🙇‍♂️
Do you think it might be necessary to verify whether it is imported from a package?

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 25, 2025
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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!

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Feb 24, 2025
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Feb 27, 2025
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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
Copy link
Member

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.

Copy link
Contributor Author

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!😂)

Copy link
Member

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?

Copy link
Member

@kirkwaiblinger kirkwaiblinger Mar 24, 2025

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?

Copy link
Contributor Author

@y-hsgw y-hsgw Apr 11, 2025

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) {
Copy link
Member

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.

Copy link
Contributor Author

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

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Mar 17, 2025
@y-hsgw y-hsgw requested a review from JoshuaKGoldberg April 11, 2025 12:38
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Apr 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [no-deprecated] should allow ignoring of deprecated value
3 participants