feat(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion #7691

StyleShit · 2023-09-24T12:05:52Z

typescript-eslint · 2023-09-24T12:05:54Z

Thanks for the PR, @StyleShit!

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.

netlify · 2023-09-24T12:05:56Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`52af550`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/653168ebad3b8700084a1c0d
😎 Deploy Preview	https://deploy-preview-7691--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 (🟢 up 4 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.

Closes typescript-eslint#7643

nx-cloud · 2023-09-24T12:07:36Z

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 19 targets

Sent with 💌 from NxCloud.

packages/eslint-plugin/src/rules/no-unsafe-enum-comparison.ts

StyleShit · 2023-09-27T06:41:16Z

@JoshuaKGoldberg

OK, should be better now, but I still can't figure out the types there 😓

…nsafe-enum-comparison-suggestion

JoshuaKGoldberg

Really good start so far! The code looks clean and I like the general direction. 😄

Left a few comments and suggestions for how to overcome the // @ts-expect-errors. I suspect they'll end up showing you a bunch more test cases to add. Have fun!

packages/eslint-plugin/tests/rules/no-unsafe-enum-comparison.test.ts

packages/eslint-plugin/src/rules/no-unsafe-enum-comparison.ts

packages/eslint-plugin/src/rules/enum-utils/shared.ts

…suggestion' into tweak/no-unsafe-enum-comparison-suggestion

…nsafe-enum-comparison-suggestion

packages/eslint-plugin/src/rules/enum-utils/shared.ts

JoshuaKGoldberg · 2023-10-17T18:42:10Z

packages/eslint-plugin/src/rules/enum-utils/shared.ts

+ * - Fruit.Apple | Vegetable.Lettuce --> [Fruit.Apple, Vegetable.Lettuce]
+ * - Fruit.Apple | Vegetable.Lettuce | 123 --> [Fruit.Apple, Vegetable.Lettuce]
+ * - T extends Fruit --> [Fruit]
+ */


[Praise] Great comments, thanks for continuing the existing standard 🙂

JoshuaKGoldberg

Looking great! Structure is solid, good test coverage, super readable code. Nice!

Just requesting changes on a bit more test coverage and some getText() -> name touchups.

packages/eslint-plugin/src/rules/enum-utils/shared.ts

JoshuaKGoldberg · 2023-10-17T18:51:08Z

packages/eslint-plugin/tests/rules/no-unsafe-enum-comparison.test.ts

+          'a' = 1,
+        }
+        declare const stringKey: StringKey;
+        stringKey === StringKey['a'];


StringKey['a'];

Just confirming explicitly in case someone looks at this in the future: I think it's fine to have it look like StringKey['a'] instead of StringKey.a. They're functionally the same, and there are other rules around stylistic concerns.

…nsafe-enum-comparison-suggestion

StyleShit · 2023-10-17T20:05:10Z

packages/eslint-plugin/src/rules/enum-utils/shared.ts

+          return `${enumName}['${memberNameIdentifier.text}']`;
+
+        case ts.SyntaxKind.ComputedPropertyName:
+          return `${enumName}[${memberNameIdentifier.expression.getText()}]`;


had to use .getText() here, there is no .text for some reason
seems like it's fine? See the tests for that as a reference

The type of memberNameIdentifier.expression is ts.Expression, which is a pretty wide type. You could as assert it to the union of types that are actually allowed as enum member names... or just go with .getText(). If the unit tests aren't showing any bad behavior, it's probably fine. 😎

I would probably keep it like this, seems fine in the tests (unless I'm missing some cases?)

The existing bugs in #7768 make me not too motivated to get every single possible edge case in this PR. The tests you've added are pretty great. Thanks!

packages/eslint-plugin/src/rules/enum-utils/shared.ts

…nsafe-enum-comparison-suggestion

StyleShit · 2023-10-18T16:47:58Z

packages/eslint-plugin/tests/rules/no-unsafe-enum-comparison.test.ts

+        enum ComputedKey {
+          [\`test-
+          key\` /* with comment */] = 1,
+        }


(Why is this even legal?!)

to make our lives harder 🫠

It's hard enough without it! 😭

…nsafe-enum-comparison-suggestion

JoshuaKGoldberg

Nice! Great investigation resulting in a nice set of test coverage & fixing. Thanks for working with me on this on @StyleShit!

We can always tackle more edge cases in the followup #7768.

feat(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion

0471e12

Closes typescript-eslint#7643

StyleShit force-pushed the tweak/no-unsafe-enum-comparison-suggestion branch from 8725058 to 0471e12 Compare September 24, 2023 12:07

StyleShit changed the title ~~tweak(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion~~ feat(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion Sep 24, 2023

JoshuaKGoldberg reviewed Sep 24, 2023

View reviewed changes

packages/eslint-plugin/src/rules/no-unsafe-enum-comparison.ts Outdated Show resolved Hide resolved

refactor + add tests

930b14a

StyleShit and others added 4 commits September 27, 2023 09:47

remove "void fixer"

b800d1b

Merge remote-tracking branch 'typescript-eslint/main' into tweak/no-u…

bbf8156

…nsafe-enum-comparison-suggestion

fix lint

d901495

Merge branch 'main' into tweak/no-unsafe-enum-comparison-suggestion

1efbc51

StyleShit marked this pull request as ready for review October 3, 2023 12:27

JoshuaKGoldberg requested changes Oct 10, 2023

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Oct 10, 2023

StyleShit added 4 commits October 17, 2023 20:22

wip

b49c446

Merge remote-tracking branch 'origin/tweak/no-unsafe-enum-comparison-…

eb577f5

…suggestion' into tweak/no-unsafe-enum-comparison-suggestion

Merge remote-tracking branch 'typescript-eslint/main' into tweak/no-u…

2e7619e

…nsafe-enum-comparison-suggestion

beautify

42928a5

StyleShit commented Oct 17, 2023

View reviewed changes

packages/eslint-plugin/src/rules/enum-utils/shared.ts Show resolved Hide resolved

StyleShit requested a review from JoshuaKGoldberg October 17, 2023 17:34

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Oct 17, 2023

StyleShit added 2 commits October 17, 2023 20:38

just changing a wrong variable name

32c3d75

just making it look & feel better and consistent

3a923ca

StyleShit commented Oct 17, 2023

View reviewed changes

packages/eslint-plugin/src/rules/enum-utils/shared.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg reviewed Oct 17, 2023

View reviewed changes

add failing test

a20fe15

JoshuaKGoldberg requested changes Oct 17, 2023

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Oct 17, 2023

StyleShit added 2 commits October 17, 2023 22:56

wip

07f9306

Merge remote-tracking branch 'typescript-eslint/main' into tweak/no-u…

f62bd56

…nsafe-enum-comparison-suggestion

StyleShit commented Oct 17, 2023

View reviewed changes

packages/eslint-plugin/src/rules/enum-utils/shared.ts Outdated Show resolved Hide resolved

StyleShit requested a review from JoshuaKGoldberg October 17, 2023 20:07

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Oct 17, 2023

StyleShit added 2 commits October 18, 2023 19:43

added some more tests to cover stupid cases

9c492f7

Merge remote-tracking branch 'typescript-eslint/main' into tweak/no-u…

7ce6387

…nsafe-enum-comparison-suggestion

StyleShit commented Oct 18, 2023

View reviewed changes

This was referenced Oct 19, 2023

Bug: [switch-exhaustiveness-check] Enum cases are not properly qualified #7747

Open

Bug: [switch-exhaustiveness-check] Some cases for member names are not being fixed properly #7768

Closed

StyleShit and others added 3 commits October 19, 2023 20:29

moar stupid tests

cf56040

Merge remote-tracking branch 'typescript-eslint/main' into tweak/no-u…

acea5f6

…nsafe-enum-comparison-suggestion

Merge branch 'main' into tweak/no-unsafe-enum-comparison-suggestion

52af550

JoshuaKGoldberg approved these changes Oct 19, 2023

View reviewed changes

JoshuaKGoldberg added the 1 approval PR that a maintainer has LGTM'd - any maintainer can merge this when ready label Oct 19, 2023

JoshuaKGoldberg merged commit 53d5263 into typescript-eslint:main Oct 19, 2023
46 checks passed

JoshuaKGoldberg mentioned this pull request Oct 19, 2023

feat(eslint-plugin): [no-unsafe-enum-comparison] handles switch cases #7541

Closed

3 tasks

github-actions bot locked as resolved and limited conversation to collaborators Oct 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion #7691

feat(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion #7691

StyleShit commented Sep 24, 2023 •

edited

typescript-eslint bot commented Sep 24, 2023

netlify bot commented Sep 24, 2023 •

edited

nx-cloud bot commented Sep 24, 2023 •

edited

StyleShit commented Sep 27, 2023

JoshuaKGoldberg left a comment

JoshuaKGoldberg Oct 17, 2023

JoshuaKGoldberg left a comment •

edited

JoshuaKGoldberg Oct 17, 2023

StyleShit Oct 17, 2023 •

edited

JoshuaKGoldberg Oct 18, 2023

StyleShit Oct 19, 2023

JoshuaKGoldberg Oct 19, 2023

StyleShit Oct 18, 2023

JoshuaKGoldberg Oct 18, 2023

StyleShit Oct 19, 2023 •

edited

JoshuaKGoldberg left a comment

feat(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion #7691

feat(eslint-plugin): [no-unsafe-enum-comparison] add switch suggestion #7691

Conversation

StyleShit commented Sep 24, 2023 • edited

typescript-eslint bot commented Sep 24, 2023

netlify bot commented Sep 24, 2023 • edited

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Sep 24, 2023 • edited

☁️ Nx Cloud Report

StyleShit commented Sep 27, 2023

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 17, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment • edited

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 17, 2023

Choose a reason for hiding this comment

StyleShit Oct 17, 2023 • edited

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 18, 2023

Choose a reason for hiding this comment

StyleShit Oct 19, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 19, 2023

Choose a reason for hiding this comment

StyleShit Oct 18, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 18, 2023

Choose a reason for hiding this comment

StyleShit Oct 19, 2023 • edited

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

StyleShit commented Sep 24, 2023 •

edited

netlify bot commented Sep 24, 2023 •

edited

nx-cloud bot commented Sep 24, 2023 •

edited

JoshuaKGoldberg left a comment •

edited

StyleShit Oct 17, 2023 •

edited

StyleShit Oct 19, 2023 •

edited