fix(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly #7806

StyleShit · 2023-10-20T12:55:58Z

…ine or single quotes are not being fixed correctly Closes typescript-eslint#7768

typescript-eslint · 2023-10-20T12:56:00Z

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-10-20T12:56:03Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`82d5b37`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6536cd5a4249380008cbf566
😎 Deploy Preview	https://deploy-preview-7806--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 90 (🔴 down 9 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.

packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts

StyleShit · 2023-10-20T12:57:47Z

packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts

+        case Enum.a: { throw new Error('Not implemented yet: Enum.a case') }
+        case Enum[\`key-with
+
+          new-line\`]: { throw new Error('Not implemented yet: Enum[\`key-with\\n\\n          new-line\`] case') }


wasn't sure about this. should we throw an error with actual new lines or \n is fine?

Yeah good question. It's such a rare case, I don't think it matters too much. But in general having error messages be on one line is easier to read.

should we just strip out any spaces, tabs, and new lines?

OK... it might look weird in some cases... IDK

key = `key-with new-line` error = "not implemented: 'key-withnew-line'";

anyway, as you said, it's a rare case that probably isn't worth the effort

StyleShit · 2023-10-20T13:05:34Z

packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.md

+<!--tabs-->
+
+### ❌ Incorrect
+


it's probably not displayed correctly, would be happy to get some help here regarding how we should display this (maybe add a subtitle?):

https://deploy-preview-7806--typescript-eslint.netlify.app/rules/switch-exhaustiveness-check#examples

 is what you're looking for.

I'd also request a brief sentence before each of the examples explaining what they're for. It's kind of hard to piece together just from the code.

Vague starting proposal (just off the top of my head, not attached to this):

When the switch doesn't have exhaustive cases, either filling them all out or adding a default will correct the rule's complaint.

nx-cloud · 2023-10-20T13:23:44Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 82d5b37. 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.

JoshuaKGoldberg

Looks great to me, thanks! With the exception of the /tabs bit, this is all just small non-blocking nitpicks from me.

JoshuaKGoldberg · 2023-10-22T16:35:32Z

packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.md

@@ -1,15 +1,15 @@
 ---
-description: 'Require switch-case statements to be exhaustive with union type.'
+description: 'Require switch-case statements to be exhaustive with union type or enum.'


[Proofreading] Existing typo with the singular/plural, heh:

Suggested change

description: 'Require switch-case statements to be exhaustive with union type or enum.'

description: 'Require switch-case statements to be exhaustive with union types and enums.'

JoshuaKGoldberg · 2023-10-22T16:36:23Z

packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.md

+<!--tabs-->
+
+### ❌ Incorrect
+


 is what you're looking for.

I'd also request a brief sentence before each of the examples explaining what they're for. It's kind of hard to piece together just from the code.

Vague starting proposal (just off the top of my head, not attached to this):

When the switch doesn't have exhaustive cases, either filling them all out or adding a default will correct the rule's complaint.

JoshuaKGoldberg · 2023-10-22T16:37:10Z

packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.md

+  Cherry,
+}
+
+const fruit = Fruit.Cherry as Fruit;


[Style] This is a little closer to the intent:

Suggested change

const fruit = Fruit.Cherry as Fruit;

declare const fruit: Fruit;

(this and elsewhere)

yup, I actually wanted to do that, but followed the existing code
changed :)

JoshuaKGoldberg · 2023-10-22T19:44:01Z

packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts

+        case Enum.a: { throw new Error('Not implemented yet: Enum.a case') }
+        case Enum[\`key-with
+
+          new-line\`]: { throw new Error('Not implemented yet: Enum[\`key-with\\n\\n          new-line\`] case') }


Yeah good question. It's such a rare case, I don't think it matters too much. But in general having error messages be on one line is easier to read.

JoshuaKGoldberg · 2023-10-22T19:44:37Z

packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts

        }

-        const errorMessage = `Not implemented yet: ${caseTest} case`;
+        // escape single quotes and newlines, so that the error message is a readable and valid code.


Suggested change

// escape single quotes and newlines, so that the error message is a readable and valid code.

// escape single quotes and newlines, so that the error message is readable and valid code.

I'm gonna learn English here more than ASTs

JoshuaKGoldberg · 2023-10-22T19:44:52Z

packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts

@@ -17,7 +17,7 @@ export default createRule({
    type: 'suggestion',
    docs: {
      description:
-        'Require switch-case statements to be exhaustive with union type',
+        'Require switch-case statements to be exhaustive with union type or enum',


(same existing typo-ish)

Suggested change

'Require switch-case statements to be exhaustive with union type or enum',

'Require switch-case statements to be exhaustive with union types or enums',

StyleShit · 2023-10-23T16:45:11Z

Looks great to me, thanks! With the exception of the /tabs bit, this is all just small non-blocking nitpicks from me.

Nits are blockers for me 😄

…-exhaustiveness-check-new-line-and-single-quotes

Josh-Cena

Suggested test case:

enum E {
  "'a' `b` \"c\"" = 1
}

declare const a: Enum;

switch (a) {}

Josh-Cena · 2023-10-23T18:02:41Z

packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts

+          const requiresBackticks = missingBranchName?.match(/[\r\n]/g);
+
+          caseTest = requiresBackticks
+            ? `${symbolName}[\`${missingBranchName}\`]`
+            : `${symbolName}['${missingBranchName}']`;


I don't know if it's discussed yet, but if we are escaping characters in the error message anyway, I would prefer text here to also be escaped instead of wrapping in backticks. Otherwise, you would also need to deal with ` in the text. (Do we even deal with ' correctly?)

OK, so your suggested case breaks the code (nice catch!)
But I'm not sure that I understand what you mean in this comment, can you maybe show some pseudo code and/or cases?

It means we simply output case '${escapedCaseTest}': { throw new Error('Not implemented yet: "${escapedCaseTest}" case') }. One consistent string literal to be used in both places. Then, you would only need to take care of ', \n, and \r in your escaping logic. By the way, if you want to be pedantic, you also need to take care of \u2028 and \u2029, which are also line terminators.

In terms of cases, it means we output:

switch (a) { case 'a\nb': { throw new Error('Not implemented yet: "a\nb" case') } }

Instead of:

switch (a) { case `a b`: { throw new Error('Not implemented yet: "a\nb" case') } }

I'm sure no one writes code like the latter, especially with deeper indentations.

I'm not sure that we can use the same escapedCaseTest variable, because we still need to re-escape It before using it in the error, right? Or am I missing something?

Have a look at this one

Is that what you mean?

Josh-Cena

This looks good to me :)

JoshuaKGoldberg

feat(eslint-plugin): [switch-exhaustiveness-check] members with new l…

e2b3789

…ine or single quotes are not being fixed correctly Closes typescript-eslint#7768

StyleShit commented Oct 20, 2023

View reviewed changes

packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts Show resolved Hide resolved

StyleShit commented Oct 20, 2023

View reviewed changes

StyleShit changed the title ~~feat(eslint-plugin): [switch-exhaustiveness-check] members with new line or single quotes are not being fixed correctly~~ feat(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly Oct 20, 2023

StyleShit added 2 commits October 20, 2023 16:21

cleanup

dd729d1

oops

fd21aa4

StyleShit changed the title ~~feat(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly~~ fix(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly Oct 21, 2023

JoshuaKGoldberg requested changes Oct 22, 2023

View reviewed changes

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

StyleShit added 2 commits October 23, 2023 19:46

wip wip

1acfe46

Merge remote-tracking branch 'typescript-eslint/main' into fix/switch…

17c9ef7

…-exhaustiveness-check-new-line-and-single-quotes

StyleShit requested a review from JoshuaKGoldberg October 23, 2023 16:56

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

Josh-Cena reviewed Oct 23, 2023

View reviewed changes

StyleShit added 2 commits October 23, 2023 22:42

maybe?

c63f866

idk why it was missing

82d5b37

bradzacher added the bug Something isn't working label Nov 10, 2023

Josh-Cena approved these changes Nov 15, 2023

View reviewed changes

Josh-Cena added the 1 approval PR that a maintainer has LGTM'd - any maintainer can merge this when ready label Nov 15, 2023

JoshuaKGoldberg approved these changes Nov 16, 2023

View reviewed changes

JoshuaKGoldberg merged commit a034d0a into typescript-eslint:main Nov 16, 2023
46 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Nov 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly #7806

fix(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly #7806

StyleShit commented Oct 20, 2023

typescript-eslint bot commented Oct 20, 2023

netlify bot commented Oct 20, 2023 •

edited

StyleShit Oct 20, 2023

JoshuaKGoldberg Oct 22, 2023

StyleShit Oct 23, 2023

StyleShit Oct 20, 2023 •

edited

JoshuaKGoldberg Oct 22, 2023

StyleShit Oct 23, 2023

nx-cloud bot commented Oct 20, 2023 •

edited

JoshuaKGoldberg left a comment

JoshuaKGoldberg Oct 22, 2023

StyleShit Oct 23, 2023

JoshuaKGoldberg Oct 22, 2023

JoshuaKGoldberg Oct 22, 2023

StyleShit Oct 23, 2023

JoshuaKGoldberg Oct 22, 2023

JoshuaKGoldberg Oct 22, 2023

StyleShit Oct 23, 2023

JoshuaKGoldberg Oct 22, 2023

StyleShit Oct 23, 2023

StyleShit commented Oct 23, 2023 •

edited

Josh-Cena left a comment

Josh-Cena Oct 23, 2023

StyleShit Oct 23, 2023

Josh-Cena Oct 23, 2023 •

edited

StyleShit Oct 23, 2023 •

edited

StyleShit Oct 23, 2023 •

edited

Josh-Cena left a comment

JoshuaKGoldberg left a comment

	description: 'Require switch-case statements to be exhaustive with union type or enum.'
	description: 'Require switch-case statements to be exhaustive with union types and enums.'

	const fruit = Fruit.Cherry as Fruit;
	declare const fruit: Fruit;

	// escape single quotes and newlines, so that the error message is a readable and valid code.
	// escape single quotes and newlines, so that the error message is readable and valid code.

	'Require switch-case statements to be exhaustive with union type or enum',
	'Require switch-case statements to be exhaustive with union types or enums',

		<!--tabs-->

		### ❌ Incorrect

		<!--tabs-->

		### ❌ Incorrect

fix(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly #7806

fix(eslint-plugin): [switch-exhaustiveness-check] enum members with new line or single quotes are not being fixed correctly #7806

Conversation

StyleShit commented Oct 20, 2023

typescript-eslint bot commented Oct 20, 2023

netlify bot commented Oct 20, 2023 • edited

✅ Deploy Preview for typescript-eslint ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StyleShit Oct 20, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nx-cloud bot commented Oct 20, 2023 • edited

☁️ Nx Cloud Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StyleShit commented Oct 23, 2023 • edited

Josh-Cena left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Josh-Cena Oct 23, 2023 • edited

Choose a reason for hiding this comment

StyleShit Oct 23, 2023 • edited

Choose a reason for hiding this comment

StyleShit Oct 23, 2023 • edited

Choose a reason for hiding this comment

Josh-Cena left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

netlify bot commented Oct 20, 2023 •

edited

StyleShit Oct 20, 2023 •

edited

nx-cloud bot commented Oct 20, 2023 •

edited

StyleShit commented Oct 23, 2023 •

edited

Josh-Cena Oct 23, 2023 •

edited

StyleShit Oct 23, 2023 •

edited

StyleShit Oct 23, 2023 •

edited