typescript-eslint/typescript-eslintPublic

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

fix(eslint-plugin): [switch-exhaustiveness-check] fix new allowDefaultCaseForExhaustiveSwitch option#8176

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 9 commits intotypescript-eslint:mainfromZamiell:fix-switch

Jan 8, 2024

Merged

fix(eslint-plugin): [switch-exhaustiveness-check] fix new allowDefaultCaseForExhaustiveSwitch option#8176

JoshuaKGoldberg merged 9 commits intotypescript-eslint:mainfromZamiell:fix-switch

Jan 8, 2024

Conversation

Copy link

Contributor

Zamiell commentedJan 2, 2024•
edited
Loading

PR Checklist

Addresses an existing open issue:fixesBug: [switch-exhaustiveness-check] fails with option "allowDefaultCaseForExhaustiveSwitch": false #8165
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

At first I thought this was a trivial fix to just check forisUnion, but then someone pointed out that it would fail forstring | number, which is a union, but should actually have a default case.

Thus, I revert to creating adoesTypeContainNonLiteralType function.

fix(allowDefaultCaseForExhaustiveSwitch): rule

8fa47a1

Copy link

Contributor

typescript-eslintbot commentedJan 2, 2024

Thanks for the PR,@Zamiell!

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 commentedJan 2, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`1ad227a`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/659c22a445907f0008c84185
😎 Deploy Preview	https://deploy-preview-8176--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (no change from production) Accessibility: 100 (no change from production) Best Practices: 92 (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.

Zamiell marked this pull request as ready for review

January 2, 2024 22:32

chore: format

8a48533

Copy link

Contributor

ArnaudBarre commentedJan 4, 2024•
edited
Loading

I was just hit by the issue when enabling this new option that looks good!
Thanks for already fixing it, but I'm a bit afraid theisUnion check can lead to issues, for example does default will be allow with:number | string switch or with"A" | "B" | string? Ideally what you want is to be able to detect if the switch type is finite or not

Copy link

ContributorAuthor

Zamiell commentedJan 4, 2024

@ArnaudBarre You are right, I will add the following "allow" test to address this:

// switch with default clause on primitive +// "allowDefaultCaseForExhaustiveSwitch" option{code:`declare const value: number | string;switch (value) {  case 0:    return 0;  case 1:    return 1;  default:    return -1;}      `,options:[{allowDefaultCaseForExhaustiveSwitch:false,requireDefaultForNonUnion:false,},],},