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

Merged
merged 27 commits into from
Jul 7, 2025

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 3b3b72a
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/686bc373a1876600085d8da2
😎 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: 98 (no change from production)
Accessibility: 97 (🔴 down 3 from production)
Best Practices: 100 (no change from production)
SEO: 92 (🔴 down 8 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 3b3b72a

Command Status Duration Result
nx test eslint-plugin-internal --coverage=false ❌ Failed 11s View ↗
nx run-many -t lint ✅ Succeeded 3m 16s View ↗
nx run-many -t typecheck ✅ Succeeded 2m 14s View ↗
nx run integration-tests:test ✅ Succeeded 5s View ↗
nx run types:build ✅ Succeeded 5s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded 1s View ↗
nx run generate-configs ✅ Succeeded 6s View ↗
nx run-many --target=build --parallel --exclude... ✅ Succeeded 22s View ↗
Additional runs (26) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-07-07 13:05:11 UTC

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.85%. Comparing base (5e3288a) to head (3b3b72a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10670      +/-   ##
==========================================
+ Coverage   90.84%   90.85%   +0.01%     
==========================================
  Files         501      501              
  Lines       50919    50978      +59     
  Branches     8387     8407      +20     
==========================================
+ Hits        46256    46315      +59     
  Misses       4648     4648              
  Partials       15       15              
Flag Coverage Δ
unittest 90.85% <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...

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

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

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

I think this is in good shape!

@JoshuaKGoldberg

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.

This is great, thank you! 🙌 I'm very excited to see this land.

return typeof specifierName === 'string' ? [specifierName] : specifierName;
};

const getStaticName = (node: TSESTree.Node): string | undefined => {
Copy link
Member

Choose a reason for hiding this comment

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

[Non-Actionable] I'm surprised we don't already have a function like this somewhere 😄. I spent a bit searching and couldn't find one. The closest was getNameFromMember over in eslint-plugin but it's not quite the same. Ah well.

@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jul 7, 2025
@JoshuaKGoldberg
Copy link
Member

The CI unit testing failure is unrelated flake.

@JoshuaKGoldberg JoshuaKGoldberg merged commit d1388fc into typescript-eslint:main Jul 7, 2025
62 of 64 checks passed
@y-hsgw y-hsgw deleted the fix/no-deprecated branch July 7, 2025 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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