Skip to content
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

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

Merged
merged 9 commits into from Jan 8, 2024

Conversation

Zamiell
Copy link
Contributor

@Zamiell Zamiell commented Jan 2, 2024

PR Checklist

Overview

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

Thus, I revert to creating a doesTypeContainNonLiteralType function.

@typescript-eslint
Copy link
Contributor

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

netlify bot commented Jan 2, 2024

Deploy Preview for typescript-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...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
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 your Netlify site configuration.

@Zamiell Zamiell marked this pull request as ready for review January 2, 2024 22:32
@ArnaudBarre
Copy link
Contributor

ArnaudBarre commented Jan 4, 2024

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 the isUnion 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

@Zamiell
Copy link
Contributor Author

Zamiell commented Jan 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,
        },
      ],
    },

@Zamiell
Copy link
Contributor Author

Zamiell commented Jan 4, 2024

In order to address this, I added a new prop to the metadata called containsNonLiteralType.

JoshuaKGoldberg
JoshuaKGoldberg previously approved these changes Jan 8, 2024
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Thanks!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 5205192 into typescript-eslint:main Jan 8, 2024
55 checks passed
@Zamiell Zamiell deleted the fix-switch branch January 8, 2024 16:50
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [switch-exhaustiveness-check] fails with option "allowDefaultCaseForExhaustiveSwitch": false
3 participants