Skip to content

fix(eslint-plugin): [prefer-optional-chain] ignore check option for most RHS of a chain #11272

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 24 commits into
base: main
Choose a base branch
from

Conversation

nayounsang
Copy link
Contributor

@nayounsang nayounsang commented Jun 5, 2025

PR Checklist

Overview

  • Apply check option to LHSs except most RHS to fix the bug where void functions were not reported

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @nayounsang!

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 Jun 5, 2025

Deploy Preview for typescript-eslint failed.

Name Link
🔨 Latest commit 6fafc22
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/687df16988859200088861a6

Copy link

nx-cloud bot commented Jun 5, 2025

View your CI Pipeline Execution ↗ for commit 6fafc22

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

☁️ Nx Cloud last updated this comment at 2025-07-21 08:08:03 UTC

@nayounsang nayounsang changed the title fix(prefer-optional-chain): should report case that can be converted to optional function call ?.() fix(eslint-plugin): should report case that can be converted to optional function call ?.() when using perfer-optional-chain Jun 5, 2025
@nayounsang nayounsang marked this pull request as draft June 5, 2025 07:38
Copy link

codecov bot commented Jun 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.86%. Comparing base (3f58afe) to head (6fafc22).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11272   +/-   ##
=======================================
  Coverage   90.86%   90.86%           
=======================================
  Files         503      503           
  Lines       51036    51030    -6     
  Branches     8424     8416    -8     
=======================================
- Hits        46373    46368    -5     
  Misses       4648     4648           
+ Partials       15       14    -1     
Flag Coverage Δ
unittest 90.86% <100.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...efer-optional-chain-utils/gatherLogicalOperands.ts 100.00% <100.00%> (ø)

... and 5 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.

@nayounsang nayounsang changed the title fix(eslint-plugin): should report case that can be converted to optional function call ?.() when using perfer-optional-chain fix(eslint-plugin): should report case that can be converted to optional void function call ?.() when using perfer-optional-chain Jun 5, 2025
@nayounsang nayounsang marked this pull request as ready for review June 5, 2025 08:11
@kirkwaiblinger kirkwaiblinger changed the title fix(eslint-plugin): should report case that can be converted to optional void function call ?.() when using perfer-optional-chain fix(eslint-plugin): [prefer-optional-chain] should report case that can be converted to optional void function call ?.() Jun 6, 2025
@kirkwaiblinger kirkwaiblinger changed the title fix(eslint-plugin): [prefer-optional-chain] should report case that can be converted to optional void function call ?.() fix(eslint-plugin): [prefer-optional-chain] should report case that can be converted to optional void function call ?.() Jun 6, 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.

This generally looks great! Just one big question on the implementation approach we want to take. Looking forward to hearing your thoughts!

@kirkwaiblinger kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label Jun 6, 2025
@kirkwaiblinger
Copy link
Member

This PR has the effect that the following code is flagged (with checkVoid enabled)

declare const maybeVoid: void | { x: () => { some: 'object' } };
maybeVoid && maybeVoid.x();

I'm not sure that that's what we want? I'd say instead the goal is that a void-returning function call at the end of a chain whose return value isn't used should be reported regardless of the check* options.

In other words, as far as implementation - we're not looking to include possibly-void values in checked chains except as the type of a function call at the end of the chain. It's not obvious to me that we need to create an option at all for this...

WDYT?

@kirkwaiblinger
Copy link
Member

kirkwaiblinger commented Jul 7, 2025

I've realized — I think this is a much more general bug. The check* options should not apply to the right hand side member of a chain. Only the left member. That is to say,

declare const x: { a: string };

// checkString: true
const y = x && x.a; // correctly reports

// checkString: false
const y = x && x.a; // (BUG) doesn't report

So, if we generally fix the logic so that the type checking only applies to the LHS of a potential chain expression x?.a, that should also automatically fix the reported bug regarding x?.a() as a special case.

@nayounsang
Copy link
Contributor Author

Then, I guess we can check it except for right most. I will finish the work on void and reply.

@nayounsang
Copy link
Contributor Author

nayounsang commented Jul 12, 2025

After thinking about it further with comments and usage examples, I think the checkVoid option is not necessary. checkXXX is useful when there is an accessible method. When considering real-world usage, I couldn't think of a case where checkXXX would be used for void.

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jul 12, 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 moving in the right direction, but the current state of the PR seems to be mostly extraneous changes. Let's clean it up to be focused on the changes related to the bug. Thanks!

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.

(see review)

@kirkwaiblinger kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label Jul 14, 2025
@nayounsang
Copy link
Contributor Author

nayounsang commented Jul 16, 2025

Oh, sorry. I misunderstood your review. Now I know what to do
I'll revert all of changes because, I changed so much and produce unnecessary codes.
Then, applying the logic to check except most RHS, I will focus on whether the issue case passes.
And if there is any problem, I will ask you. Thank you.

@nayounsang nayounsang changed the title fix(eslint-plugin): [prefer-optional-chain] should report case that can be converted to optional void function call ?.() fix(eslint-plugin): [prefer-optional-chain] ignore check option for most RHS of a chain Jul 16, 2025
@kirkwaiblinger
Copy link
Member

Hey @nayounsang — is this ready for another review pass? If so, we ask that you request review in the GUI so we know to take another look. If not, take your time and don't mind me! Just looked like it might be ready for another pass. Thanks!

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jul 20, 2025
kirkwaiblinger
kirkwaiblinger previously approved these changes Jul 21, 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.

Thanks!

@kirkwaiblinger kirkwaiblinger 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 21, 2025
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: [prefer-optional-chain] should report case that can be converted to optional function call ?.()
2 participants
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