typescript-eslint/typescript-eslintPublic

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

fix(eslint-plugin): [no-unnecessary-boolean-literal-compare] fixer should handle parentheses#6569

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 4 commits intomainfromfix/no-unnecessary-boolean-literal-compare-braces

Mar 13, 2023

Merged

fix(eslint-plugin): [no-unnecessary-boolean-literal-compare] fixer should handle parentheses#6569

JoshuaKGoldberg merged 4 commits intomainfromfix/no-unnecessary-boolean-literal-compare-braces

Mar 13, 2023

Conversation

Copy link

Collaborator

armano2 commentedMar 4, 2023•
edited
Loading

PR Checklist

Addresses an existing open issue:fixesBug: [no-unnecessary-boolean-literal-compare] Quick Fix generates bug withinstanceof #6567
That issue was marked asaccepting prs
Steps inCONTRIBUTING.md were taken

Overview

Add missing handling for removal and adding parenthesis in rule fixer

new cases covered:

if((xinstanceofError)===false){}if(false===(xinstanceofError)){}if(xinstanceofError===false){}

old fixer result

if(!(xinstanceofError){}if(!xinstanceofError)){}if(!xinstanceofError){}

new fixer result

if(!(xinstanceofError)){}if(!(xinstanceofError)){}if(!(xinstanceofError)){}

initially i was planning to extend range of fixer to include)( but after further investigation this started generating to many edge cases

eg.(false) === x instanceof Error

fix(eslint-plugin): [no-unnecessary-boolean-literal-compare] fixer sh…

bdf04c3

…ould handle parentheses

Copy link

nx-cloudbot commentedMar 4, 2023•
edited
Loading

☁️ Nx Cloud Report

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

📂 See all runs for this branch

✅ Successfully ran 46 targets

Sent with 💌 fromNxCloud.

Copy link

Contributor

typescript-eslintbot commentedMar 4, 2023

Thanks for the PR,@armano2!

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 commentedMar 4, 2023•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`79de5c2`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6403a01a1f961b0008db9ab8
😎 Deploy Preview	https://deploy-preview-6569--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to yourNetlify site settings.

Merge remote-tracking branch 'origin/main' into fix/no-unnecessary-bo…

c481273

…olean-literal-compare-braces

armano2 marked this pull request as draft

March 4, 2023 19:04

Copy link

codecovbot commentedMar 4, 2023•
edited
Loading

Codecov Report

Merging#6569 (79de5c2) intomain (9427b7c) willincrease coverage by0.04%.
The diff coverage is100.00%.

Additional details and impacted files

@@            Coverage Diff             @@##             main    #6569      +/-   ##==========================================+ Coverage   90.66%   90.71%   +0.04%==========================================  Files         376      376                Lines       12851    12855       +4       Branches     3783     3783              ==========================================+ Hits        11651    11661      +10+ Misses        856      850       -6  Partials      344      344

Flag	Coverage Δ
unittest	`90.71% <100.00%> (+0.04%)`	⬆️

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

Impacted Files	Coverage Δ
...rc/rules/no-unnecessary-boolean-literal-compare.ts	`97.67% <100.00%> (+7.31%)`	⬆️
...ackages/eslint-plugin/src/util/getWrappingFixer.ts	`100.00% <100.00%> (ø)`

armano2 added2 commits

March 4, 2023 20:43

fix: simplify code and add missing handling for additional cases

768cc36

fix: small code refactor

79de5c2

armano2 marked this pull request as ready for review

March 4, 2023 19:49

armano2 commented

Mar 5, 2023

View reviewed changes

packages/eslint-plugin/src/rules/no-unnecessary-boolean-literal-compare.ts

		);

		// if the expression `exp` isn't nullable, or we're comparing to `true`,
		// we can just replace the entire comparison with `exp` or `!exp`

Copy link

CollaboratorAuthor

armano2Mar 5, 2023•
edited
Loading

Choose a reason for hiding this comment

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

after further investigation we could simplify this fixer to

          fix:function*(fixer){constisUnaryNegation=node.parent!=null&&nodeIsUnaryNegation(node.parent);constmutatedNode=isUnaryNegation ?node.parent! :node;yieldfixer.replaceText(mutatedNode,sourceCode.getText(comparison.expression),);constshouldNegate=comparison.literalBooleanInComparison              ?!comparison.negated              :comparison.negated;if(isUnaryNegation===shouldNegate){yieldfixer.insertTextBefore(mutatedNode,'!');if(!util.isStrongPrecedenceNode(comparison.expression)){yieldfixer.insertTextBefore(mutatedNode,'(');yieldfixer.insertTextAfter(mutatedNode,')');}}// if the expression `exp` is nullable, and we're not comparing to `true`,// we can just replace the entire comparison with `exp` or `!exp`if(comparison.expressionIsNullableBoolean&&!comparison.literalBooleanInComparison){// provide the default `true`yieldfixer.insertTextBefore(mutatedNode,'(');yieldfixer.insertTextAfter(mutatedNode,' ?? true)');}}

that should allow us to provide better fixer for

// sourceif(!(varBoolean===false)){}// currentif(!(!varBoolean)){}// newif(varBoolean){}

i'm not sure if we should push this with this fix

Copy link

Member

JoshuaKGoldbergMar 8, 2023

Choose a reason for hiding this comment

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

I like it 😄 +1 to including it here. Also a +1 to filing a followup if you want to get this in sooner.

Copy link

Member

bradzacherMar 13, 2023

Choose a reason for hiding this comment

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

I'm going to land this as-is for now, just so we can get this fix out with the next release.
We can follow-up next week with the changes to simplify this fixer later

JoshuaKGoldberg approved these changes

Mar 8, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

💯

packages/eslint-plugin/src/rules/no-unnecessary-boolean-literal-compare.ts

		);

		// if the expression `exp` isn't nullable, or we're comparing to `true`,
		// we can just replace the entire comparison with `exp` or `!exp`

Copy link

Member

JoshuaKGoldbergMar 8, 2023

Choose a reason for hiding this comment

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

I like it 😄 +1 to including it here. Also a +1 to filing a followup if you want to get this in sooner.

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

Mar 8, 2023

bradzacher added awaiting responseIssues waiting for a reply from the OP or another party and removed awaiting responseIssues waiting for a reply from the OP or another party labels

Mar 13, 2023

bradzacher added this pull request to the merge queue

Mar 13, 2023

bradzacher added the bugSomething isn't working label

Mar 13, 2023