Skip to content

fix(eslint-plugin): [no-deprecated] report on deprecated properties with function-like types #9977

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Sep 13, 2024
Merged

fix(eslint-plugin): [no-deprecated] report on deprecated properties with function-like types #9977

merged 6 commits into from
Sep 13, 2024

Conversation

auvred
Copy link
Member

@auvred auvred commented Sep 12, 2024

PR Checklist

Overview

declare interface SomeInterface {
  /** @deprecated */
  property: () => void;

  /** @deprecated */
  method(): void;
}

declare const someInterface: SomeInterface;
someInterface.property(); // ❌ missing error
someInterface.method(); // ✅ errors

Both property and method identifiers have call signatures, but:

  • method has "deprecated" jsdoc tag on its signature
  • property has "deprecated" jsdoc tag on its symbol

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @auvred!

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.

@netlify Netlify
Copy link

netlify bot commented Sep 12, 2024 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit bd55ac8
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/66e2fc250ee4c6000837d4cd
😎 Deploy Preview https://deploy-preview-9977--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: 90 (🔴 down 5 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (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 site configuration.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Sep 12, 2024 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b5ccb96. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

@netlify Netlify
Copy link

netlify bot commented Sep 12, 2024 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit b5ccb96
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/66e309ab3607a10009e51023
😎 Deploy Preview https://deploy-preview-9977--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 (🟢 up 3 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (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 site configuration.

kirkwaiblinger
kirkwaiblinger reviewed Sep 12, 2024
View reviewed changes
packages/eslint-plugin/src/rules/no-deprecated.ts
// interface Props {
// /** @deprecated */
// property: () => 'foo'
// ^symbol^ ^signature^
Copy link
Member

Choose a reason for hiding this comment

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

(praise) Immensely helpful comment 🫶

@codecov Codecov
Copy link

codecov bot commented Sep 12, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.69%. Comparing base (3710c9c) to head (b5ccb96).
Report is 5 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #9977   +/-   ##
=======================================
  Coverage   88.69%   88.69%           
=======================================
  Files         425      425           
  Lines       14807    14811    +4     
  Branches     4306     4309    +3     
=======================================
+ Hits        13133    13137    +4     
  Misses       1530     1530           
  Partials      144      144
Flag Coverage Δ
unittest 88.69% <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 97.18% <100.00%> (+0.16%) ⬆️

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Sep 12, 2024
View reviewed changes
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.

+1, this is good nuance to note!

@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 Sep 12, 2024
@bradzacher bradzacher merged commit 2a956b2 into typescript-eslint:main Sep 13, 2024
62 of 64 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

@kirkwaiblinger kirkwaiblinger kirkwaiblinger approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bug: [no-deprecated] fails on declared instances
4 participants
@auvred @JoshuaKGoldberg @kirkwaiblinger @bradzacher
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy