typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.8k

fix(eslint-plugin): [prefer-nullish-coalescing] fix parenthesization bug in suggestion#11098

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

JoshuaKGoldberg merged 6 commits intotypescript-eslint:mainfrommdm317:11097-prefer-nullish-coalescing

May 2, 2025

Merged

fix(eslint-plugin): [prefer-nullish-coalescing] fix parenthesization bug in suggestion#11098

JoshuaKGoldberg merged 6 commits intotypescript-eslint:mainfrommdm317:11097-prefer-nullish-coalescing

May 2, 2025

Conversation

Copy link

Contributor

PR Checklist

Addresses an existing open issue:fixesBug: @typescript-eslint/prefer-nullish-coalescing mal-fixes nested condition #11097
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

When running theFix, add parentheses to conditional expressions that are missing them

mdm317 added2 commits

April 24, 2025 19:13

fix : Add parentheses to expressions that require them, even when the…

a92881e

…y are missing in the original code

fix : format

eb8ef5c

Copy link

Contributor

typescript-eslintbot commentedApr 24, 2025

Thanks for the PR,@mdm317!

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

netlifybot commentedApr 24, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`dd690c4`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/68137f2db62b5000081b7b24
😎 Deploy Preview	https://deploy-preview-11098--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 98 (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 yourNetlify site configuration.

Copy link

nx-cloudbot commentedApr 24, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commitdd690c4.

Command	Status	Duration	Result
`nx typecheck ast-spec`	✅ Succeeded	<1s	View ↗
`nx run-many --target=build --exclude website --...`	✅ Succeeded	1s	View ↗
`nx run-many --target=clean`	✅ Succeeded	11s	View ↗

☁️Nx Cloud last updated this comment at2025-05-01 14:25:30 UTC

Copy link

codecovbot commentedApr 24, 2025•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.84%. Comparing base(cc2d6ec) to head(dd690c4).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@##             main   #11098   +/-   ##=======================================  Coverage   90.83%   90.84%           =======================================  Files         497      497             Lines       50279    50295   +16       Branches     8297     8299    +2     =======================================+ Hits        45672    45690   +18+ Misses       4592     4590    -2  Partials       15       15

Flag	Coverage Δ
unittest	`90.84% <100.00%> (+<0.01%)`	⬆️

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

Files with missing lines	Coverage Δ
...lint-plugin/src/rules/prefer-nullish-coalescing.ts	`98.26% <100.00%> (+0.03%)`	⬆️

... and1 file 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.

fix : lint err

ed97c64

mdm317 marked this pull request as ready for review

April 24, 2025 14:30

Copy link

Contributor

OlivierZal commentedApr 24, 2025

Looks good!

kirkwaiblinger reviewed

Apr 28, 2025

View reviewed changes

Copy link

Member

kirkwaiblinger left a comment

Choose a reason for hiding this comment

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

Looks like it will solve the specific bug case but just have a question about being generic and/or reusing code. Thanks for sending!

packages/eslint-plugin/src/rules/prefer-nullish-coalescing.ts Outdated

		@@ -932,3 +934,17 @@ function formatComments(
		)
		.join('');
		}

		function getTextWithEnsuredParentheses(

Copy link

Member

kirkwaiblingerApr 28, 2025•
edited
Loading

Choose a reason for hiding this comment

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

I wonder if we can leverage existing infrastructure around parenthesization/wrapping rather than hard-code a special case fora ? b : c... is there a specific reason to do that? I worry we might miss parens on other expressions that might need it?

FWIW I had success passing all the test cases with the following...

context.report({            node,messageId:'preferNullishOverTernary',// TODO: also account for = in the ternary clausedata:{equals:''},suggest:[{messageId:'suggestNullish',data:{equals:''},fix(fixer:TSESLint.RuleFixer):TSESLint.RuleFix{returnfixer.replaceText(node,`${getTextWithParentheses(context.sourceCode,nullishCoalescingParams.nullishCoalescingLeftNode,)} ??${(()=>{constbranch=getBranchNodes(node,operator,).nullishBranch;if(isParenthesized(branch,context.sourceCode)){returngetTextWithParentheses(context.sourceCode,branch,);}returngetWrappedCode(getTextWithParentheses(context.sourceCode,branch),getOperatorPrecedenceForNode(branch),OperatorPrecedence.Coalesce,);})()}`,);},},],});

Curious what you think!

Copy link

ContributorAuthor

mdm317Apr 28, 2025

Choose a reason for hiding this comment

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

It definitely seems much better to use the existing infrastructure rather than hard-coding it!
I've updated the code to use your approach.
Thanks for pointing it out!

kirkwaiblinger added the awaiting responseIssues waiting for a reply from the OP or another party label

Apr 28, 2025

fix: leverage existing infrastructure

07a6d71

mdm317 requested a review fromkirkwaiblinger

April 30, 2025 13:55

github-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party label

Apr 30, 2025

kirkwaiblinger added2 commits

May 1, 2025 07:52

Merge branch 'main' into review/11098

e78cab4

simplify syntax

dd690c4

kirkwaiblinger approved these changes

May 1, 2025

View reviewed changes

Copy link

Member

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 for sending this in!

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

May 1, 2025

kirkwaiblinger changed the title~~fix(eslint-plugin): [prefer-nullish-coalescing] mal-fixes nested conditional expression~~fix(eslint-plugin): [prefer-nullish-coalescing] fix parenthesization bug in suggestion

May 1, 2025