Skip to content

fix(eslint-plugin): [unified-signatures] fix false positives for ignoreOverloadsWithDifferentJSDoc option #11381

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 2 commits into from
Jul 14, 2025
Merged

fix(eslint-plugin): [unified-signatures] fix false positives for ignoreOverloadsWithDifferentJSDoc option #11381

merged 2 commits into from
Jul 14, 2025
+47 −3

Conversation

y-hsgw
Copy link
Contributor

@y-hsgw y-hsgw commented Jul 7, 2025 •
edited
Loading

PR Checklist

Overview

This PR modifies the unified-signatures rule so that, when checking TSEmptyBodyFunctionExpression nodes, it also inspects the parent MethodDefinition for JSDoc comments. This ensures ignoreOverloadsWithDifferentJSDoc works correctly for class methods.

☀️

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

@netlify Netlify
Copy link

netlify bot commented Jul 7, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit ee2ea85
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/686bd4cc24c41900085ca519
😎 Deploy Preview https://deploy-preview-11381--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 (🟢 up 1 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.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jul 7, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit ee2ea85

Command Status Duration Result
nx test eslint-plugin --coverage=false ✅ Succeeded 5m 5s View ↗
nx run-many -t lint ✅ Succeeded 3m 17s View ↗
nx run-many -t typecheck ✅ Succeeded 2m 10s View ↗
nx test eslint-plugin-internal --coverage=false ✅ Succeeded 4s View ↗
nx run integration-tests:test ✅ Succeeded 5s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded 2s View ↗
nx run types:build ✅ Succeeded 5s View ↗
nx run generate-configs ✅ Succeeded 6s View ↗
Additional runs (27) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-07-07 14:19:15 UTC

@codecov Codecov
Copy link

codecov bot commented Jul 7, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.85%. Comparing base (5e3288a) to head (ee2ea85).
Report is 8 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #11381      +/-   ##
==========================================
+ Coverage   90.84%   90.85%   +0.01%     
==========================================
  Files         501      501              
  Lines       50919    50984      +65     
  Branches     8387     8408      +21     
==========================================
+ Hits        46256    46321      +65     
  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 Δ
...ages/eslint-plugin/src/rules/unified-signatures.ts 94.33% <100.00%> (+0.06%) ⬆️

... and 2 files with indirect coverage changes

🚀 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.

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Jul 14, 2025
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.

Very nicely done 💯 thanks!

@JoshuaKGoldberg JoshuaKGoldberg merged commit e1b310c into typescript-eslint:main Jul 14, 2025
74 of 76 checks passed
@y-hsgw y-hsgw deleted the fix/unified-signatures branch July 14, 2025 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bug: [unified-signatures] not ignoring different jsdocs
2 participants
@y-hsgw @JoshuaKGoldberg
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