typescript-eslint/typescript-eslintPublic

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

fix(eslint-plugin): [sort-type-constituents, sort-type-union-intersection-members] handle some required parentheses cases in the fixer#6118

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

bradzacher merged 4 commits intotypescript-eslint:mainfromcherryblossom000:sort-constituents-fix-fix

Dec 2, 2022

Merged

fix(eslint-plugin): [sort-type-constituents, sort-type-union-intersection-members] handle some required parentheses cases in the fixer#6118

bradzacher merged 4 commits intotypescript-eslint:mainfromcherryblossom000:sort-constituents-fix-fix

Dec 2, 2022

Conversation

Copy link

Contributor

cherryblossom000 commentedNov 28, 2022•
edited
Loading

PR Checklist

Addresses an existing open issue:fixesBug: [sort-type-union-intersection-members] Fix for constituents with leading pipes or ampersands produces invalid output #6117
That issue was marked asaccepting prs
Steps inCONTRIBUTING.md were taken

Overview

requiresParentheses now returnstrue for union types starting with| and intersection types starting with&.

Copy link

Contributor

typescript-eslintbot commentedNov 28, 2022

Thanks for the PR,@cherryblossom000!

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

nx-cloudbot commentedNov 28, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit2cf2ca9. 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 47 targets

Sent with 💌 fromNxCloud.

Copy link

netlifybot commentedNov 28, 2022•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`2cf2ca9`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/638541d3e7f6e00008238f48
😎 Deploy Preview	https://deploy-preview-6118--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.

Copy link

codecovbot commentedNov 28, 2022•
edited
Loading

Codecov Report

Merging#6118 (d7f2588) intomain (267da4e) willdecrease coverage by0.00%.
The diff coverage is100.00%.

❗ Current headd7f2588 differs from pull request most recent head2cf2ca9. Consider uploading reports for the commit2cf2ca9 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@##             main    #6118      +/-   ##==========================================- Coverage   91.27%   91.26%   -0.01%==========================================  Files         366      366                Lines       12417    12416       -1       Branches     3631     3632       +1     ==========================================- Hits        11333    11332       -1  Misses        774      774                Partials      310      310

Flag	Coverage Δ
unittest	`91.26% <100.00%> (-0.01%)`	⬇️

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

Impacted Files	Coverage Δ
.../eslint-plugin/src/rules/sort-type-constituents.ts	`90.38% <100.00%> (-0.36%)`	⬇️
.../src/rules/sort-type-union-intersection-members.ts	`90.38% <100.00%> (-0.36%)`	⬇️
packages/eslint-plugin/src/util/misc.ts	`97.01% <100.00%> (+0.13%)`	⬆️

JoshuaKGoldberg requested changes

Nov 28, 2022

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.

Code looks great, thanks! Just requesting changes on deduplicating it a bit. ✨

packages/eslint-plugin/src/rules/sort-type-union-intersection-members.ts OutdatedShow resolvedHide resolved

packages/eslint-plugin/src/rules/sort-type-constituents.ts Outdated

		node:TSESTree.TSIntersectionType\|TSESTree.TSUnionType,
		):void{
		constsourceOrder=node.types.map(type=>{
		constsourceOrder=node.types.map((type):Constituent=>{

Copy link

Member

Choose a reason for hiding this comment

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

Nit: any particular reason to add the return type explicitly, here and in the other file?

Copy link

ContributorAuthor

Choose a reason for hiding this comment

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

I wanted to make it clear what theConstituent was and where it came from. I ended up getting rid ofConstituent when I extractedrequiresParentheses into a utility function.

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

Nov 28, 2022

cherryblossom000 added2 commits

November 29, 2022 09:33

fix(eslint-plugin): [sort-type-constituents] correctly fix constituen…

8f54e6e

…ts with leading `|` or `&`Fixestypescript-eslint#6117

chore: create typeNodeRequiresParentheses utility

d7f2588

cherryblossom000 force-pushed thesort-constituents-fix-fix branch from9caa9eb tod7f2588Compare

November 28, 2022 22:35

Copy link

ContributorAuthor

cherryblossom000 commentedNov 28, 2022

The force push is because I rebased with main due to a merge conflict.

test: add missing semicolons

bdad4fb

Copy link

ContributorAuthor

cherryblossom000 commentedNov 28, 2022•
edited
Loading

I also realised there’s another bug with this rule:

typeT=(B|C)&A

gets fixed to

typeT=C|A&B

This is because(B | C) & A gets incorrectly fixed toA & B | C, which is then fixed toC | A & B.

fix(eslint-plugin): [sort-type-constituents] correctly fix intersecti…

2cf2ca9

…ons of unions

cherryblossom000 changed the title~~fix(eslint-plugin): [sort-type-constituents] correctly fix constituents with leading| or&~~fix(eslint-plugin): [sort-type-constituents] add missing parentheses in fix

Nov 28, 2022

bradzacher removed the awaiting responseIssues waiting for a reply from the OP or another party label

Nov 30, 2022

bradzacher reviewed

Dec 2, 2022

View reviewed changes

Copy link

Member

bradzacher left a comment

Choose a reason for hiding this comment

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

I wonder if we want to leverage TS's utilities here for completeness?
https://github.com/microsoft/TypeScript/blob/1b75edcec60415dfa77be2e04aeafce0efa2222e/src/compiler/factory/parenthesizerRules.ts

We probably can't consume them directly (cos I don't think the util existed in old versions of TS) - but we could probably fork it? Maybe something to do in a separate PR?

bradzacher approved these changes

Dec 2, 2022

View reviewed changes

Copy link

Member

bradzacher 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 the fix for both rules!

I'm going to land this as is so we can get the fix out ASAP.
If we want to strengthen the logic further we can follow up in a separate PR.

bradzacher changed the title~~fix(eslint-plugin): [sort-type-constituents] add missing parentheses in fix~~fix(eslint-plugin): [sort-type-constituents, sort-type-union-intersection-members] handle some required parentheses cases in the fixer

Dec 2, 2022

bradzacher mentioned this pull request

Dec 2, 2022

chore: allow multiple rule names in pr titles#6148

Merged

1 task

bradzacher merged commit5d49d5d intotypescript-eslint:main

Dec 2, 2022

cherryblossom000 deleted the sort-constituents-fix-fix branch

December 2, 2022 03:49

bradzacher mentioned this pull request

Dec 3, 2022