typescript-eslint/typescript-eslintPublic

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

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

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 20 commits intotypescript-eslint:mainfromStyleShit:tweak/no-unsafe-enum-comparison-suggestion

Oct 19, 2023

Merged

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

JoshuaKGoldberg merged 20 commits intotypescript-eslint:mainfromStyleShit:tweak/no-unsafe-enum-comparison-suggestion

Oct 19, 2023

Conversation

Copy link

Contributor

StyleShit commentedSep 24, 2023•
edited
Loading

Closes#7643

Copy link

Contributor

typescript-eslintbot commentedSep 24, 2023

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.

Copy link

netlifybot commentedSep 24, 2023•
edited
Loading

✅ Deploy Preview fortypescript-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 yourNetlify site configuration.

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

0471e12

Closestypescript-eslint#7643

StyleShit force-pushed thetweak/no-unsafe-enum-comparison-suggestion branch from8725058 to0471e12Compare

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

Copy link

nx-cloudbot commentedSep 24, 2023•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit52af550. 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 💌 fromNxCloud.

JoshuaKGoldberg reviewed

Sep 24, 2023

View reviewed changes

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

refactor + add tests

930b14a

Copy link

ContributorAuthor

StyleShit commentedSep 27, 2023

@JoshuaKGoldberg

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

StyleShitand others added4 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

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.

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 OutdatedShow resolvedHide resolved

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

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

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

Oct 10, 2023

StyleShit added4 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.tsShow resolvedHide resolved

StyleShit requested a review fromJoshuaKGoldberg

October 17, 2023 17:34

github-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party label

Oct 17, 2023

StyleShit added2 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 OutdatedShow resolvedHide resolved

JoshuaKGoldberg reviewed

Oct 17, 2023

View reviewed changes

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]
		*/

Copy link

Member

Choose a reason for hiding this comment

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

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

add failing test

a20fe15

JoshuaKGoldberg requested changes

Oct 17, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment•
edited
Loading

Choose a reason for hiding this comment

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

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

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

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

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

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

Copy link

Member

Choose a reason for hiding this comment

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

StringKey['a'];

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

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

Oct 17, 2023

StyleShit added2 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

		return `${enumName}['${memberNameIdentifier.text}']`;

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

Copy link

ContributorAuthor

StyleShitOct 17, 2023•
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link

Member

JoshuaKGoldbergOct 18, 2023

Choose a reason for hiding this comment

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

The type ofmemberNameIdentifier.expression ists.Expression, which is a pretty wide type. You couldas 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. 😎

Copy link

ContributorAuthor

StyleShitOct 19, 2023

Choose a reason for hiding this comment

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

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

Copy link

Member

JoshuaKGoldbergOct 19, 2023

Choose a reason for hiding this comment

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

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