feat(eslint-plugin): [switch-exhaustiveness-check] add support for "n…

…o default" comment (#10218) * feat: no default comment * feat: considerDefaultExhaustiveForUnions option apply * feat: apply regex in no default * fix: test case fix * fix: add defalutCaseCommentPattern option * feat: add testcase and docs * fix:test case * fix: code review apply * Update test snapshots * Update packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx * Fix regex complaint in code block * update test snapshots in general * Apply suggestions from code review --------- Co-authored-by: Josh Goldberg <[email protected]>
typescript-eslint · Dec 7, 2024 · 47f1ab3 · 47f1ab3
1 parent 772bd43
commit 47f1ab3
Show file tree

Hide file tree

Showing 5 changed files with 233 additions and 9 deletions.
diff --git a/packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx b/packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx
@@ -78,6 +78,27 @@ switch (literal) {
 }
 ```
 
+### `defaultCaseCommentPattern`
+
+{/* insert option description */}
+
+Default: `/^no default$/iu`.
+
+It can sometimes be preferable to omit the default case for only some switch statements.
+For those situations, this rule can be given a pattern for a comment that's allowed to take the place of a `default:`.
+
+Examples of additional **correct** code with `{ defaultCaseCommentPattern: "^skip\\sdefault" }`:
+
+```ts option='{ "defaultCaseCommentPattern": "^skip default" }' showPlaygroundButton
+declare const value: 'a' | 'b';
+
+switch (value) {
+  case 'a':
+    break;
+  // skip default
+}
+```
+
 ## Examples
 
 When the switch doesn't have exhaustive cases, either filling them all out or adding a default (if you have `considerDefaultExhaustiveForUnions` enabled) will address the rule's complaint.

diff --git a/packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts b/packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
@@ -14,9 +14,11 @@ import {
   requiresQuoting,
 } from '../util';
 
+const DEFAULT_COMMENT_PATTERN = /^no default$/iu;
+
 interface SwitchMetadata {
   readonly containsNonLiteralType: boolean;
-  readonly defaultCase: TSESTree.SwitchCase | undefined;
+  readonly defaultCase: TSESTree.Comment | TSESTree.SwitchCase | undefined;
   readonly missingLiteralBranchTypes: ts.Type[];
   readonly symbolName: string | undefined;
 }
@@ -38,6 +40,11 @@ type Options = [
      */
     requireDefaultForNonUnion?: boolean;
 
+    /**
+     * Regular expression for a comment that can indicate an intentionally omitted default case.
+     */
+    defaultCaseCommentPattern?: string;
+
     /**
      * If `true`, the `default` clause is used to determine whether the switch statement is exhaustive for union types.
      *
@@ -81,6 +88,10 @@ export default createRule<Options, MessageIds>({
             type: 'boolean',
             description: `If 'true', the 'default' clause is used to determine whether the switch statement is exhaustive for union type`,
           },
+          defaultCaseCommentPattern: {
+            type: 'string',
+            description: `Regular expression for a comment that can indicate an intentionally omitted default case.`,
+          },
           requireDefaultForNonUnion: {
             type: 'boolean',
             description: `If 'true', require a 'default' clause for switches on non-union types.`,
@@ -102,13 +113,34 @@ export default createRule<Options, MessageIds>({
       {
         allowDefaultCaseForExhaustiveSwitch,
         considerDefaultExhaustiveForUnions,
+        defaultCaseCommentPattern,
         requireDefaultForNonUnion,
       },
     ],
   ) {
     const services = getParserServices(context);
     const checker = services.program.getTypeChecker();
     const compilerOptions = services.program.getCompilerOptions();
+    const commentRegExp =
+      defaultCaseCommentPattern != null
+        ? new RegExp(defaultCaseCommentPattern, 'u')
+        : DEFAULT_COMMENT_PATTERN;
+
+    function getCommentDefaultCase(
+      node: TSESTree.SwitchStatement,
+    ): TSESTree.Comment | undefined {
+      const lastCase = node.cases.at(-1);
+      const commentsAfterLastCase = lastCase
+        ? context.sourceCode.getCommentsAfter(lastCase)
+        : [];
+      const defaultCaseComment = commentsAfterLastCase.at(-1);
+
+      if (commentRegExp.test(defaultCaseComment?.value.trim() || '')) {
+        return defaultCaseComment;
+      }
+
+      return;
+    }
 
     function getSwitchMetadata(node: TSESTree.SwitchStatement): SwitchMetadata {
       const defaultCase = node.cases.find(
@@ -170,7 +202,7 @@ export default createRule<Options, MessageIds>({
 
       return {
         containsNonLiteralType,
-        defaultCase,
+        defaultCase: defaultCase ?? getCommentDefaultCase(node),
         missingLiteralBranchTypes,
         symbolName,
       };
@@ -210,6 +242,7 @@ export default createRule<Options, MessageIds>({
                   fixer,
                   node,
                   missingLiteralBranchTypes,
+                  defaultCase,
                   symbolName?.toString(),
                 );
               },
@@ -223,11 +256,11 @@ export default createRule<Options, MessageIds>({
       fixer: TSESLint.RuleFixer,
       node: TSESTree.SwitchStatement,
       missingBranchTypes: (ts.Type | null)[], // null means default branch
+      defaultCase: TSESTree.Comment | TSESTree.SwitchCase | undefined,
       symbolName?: string,
     ): TSESLint.RuleFix {
       const lastCase =
         node.cases.length > 0 ? node.cases[node.cases.length - 1] : null;
-      const defaultCase = node.cases.find(caseEl => caseEl.test == null);
 
       const caseIndent = lastCase
         ? ' '.repeat(lastCase.loc.start.column)
@@ -349,7 +382,7 @@ export default createRule<Options, MessageIds>({
             {
               messageId: 'addMissingCases',
               fix(fixer): TSESLint.RuleFix {
-                return fixSwitch(fixer, node, [null]);
+                return fixSwitch(fixer, node, [null], defaultCase);
               },
             },
           ],

diff --git a/packages/eslint-plugin/tests/docs-eslint-output-snapshots/switch-exhaustiveness-check.shot b/packages/eslint-plugin/tests/docs-eslint-output-snapshots/switch-exhaustiveness-check.shot
diff --git a/packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts b/packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts
@@ -834,6 +834,7 @@ switch (literal) {
       options: [
         {
           considerDefaultExhaustiveForUnions: true,
+          requireDefaultForNonUnion: true,
         },
       ],
     },
@@ -954,6 +955,54 @@ function foo(x: string[], y: string | undefined) {
         },
       },
     },
+    {
+      code: `
+declare const value: number;
+switch (value) {
+  case 0:
+    break;
+  case 1:
+    break;
+  // no default
+}
+      `,
+      options: [
+        {
+          requireDefaultForNonUnion: true,
+        },
+      ],
+    },
+    {
+      code: `
+declare const value: 'a' | 'b';
+switch (value) {
+  case 'a':
+    break;
+  // no default
+}
+      `,
+      options: [
+        {
+          considerDefaultExhaustiveForUnions: true,
+        },
+      ],
+    },
+    {
+      code: `
+declare const value: 'a' | 'b';
+switch (value) {
+  case 'a':
+    break;
+  // skip default
+}
+      `,
+      options: [
+        {
+          considerDefaultExhaustiveForUnions: true,
+          defaultCaseCommentPattern: '^skip\\sdefault',
+        },
+      ],
+    },
   ],
   invalid: [
     {
@@ -2797,5 +2846,106 @@ function foo(x: string[]) {
         },
       },
     },
+    {
+      code: `
+declare const myValue: 'a' | 'b';
+switch (myValue) {
+  case 'a':
+    return 'a';
+  case 'b':
+    return 'b';
+  // no default
+}
+      `,
+      errors: [
+        {
+          messageId: 'dangerousDefaultCase',
+        },
+      ],
+      options: [
+        {
+          allowDefaultCaseForExhaustiveSwitch: false,
+        },
+      ],
+    },
+    {
+      code: `
+declare const literal: 'a' | 'b' | 'c';
+
+switch (literal) {
+  case 'a':
+    break;
+  // no default
+}
+      `,
+      errors: [
+        {
+          column: 9,
+          line: 4,
+          messageId: 'switchIsNotExhaustive',
+          suggestions: [
+            {
+              messageId: 'addMissingCases',
+              output: `
+declare const literal: 'a' | 'b' | 'c';
+
+switch (literal) {
+  case 'a':
+    break;
+  case "b": { throw new Error('Not implemented yet: "b" case') }
+  case "c": { throw new Error('Not implemented yet: "c" case') }
+  // no default
+}
+      `,
+            },
+          ],
+        },
+      ],
+      options: [
+        {
+          considerDefaultExhaustiveForUnions: false,
+        },
+      ],
+    },
+    {
+      code: `
+declare const literal: 'a' | 'b' | 'c';
+
+switch (literal) {
+  case 'a':
+    break;
+  // skip default
+}
+      `,
+      errors: [
+        {
+          column: 9,
+          line: 4,
+          messageId: 'switchIsNotExhaustive',
+          suggestions: [
+            {
+              messageId: 'addMissingCases',
+              output: `
+declare const literal: 'a' | 'b' | 'c';
+
+switch (literal) {
+  case 'a':
+    break;
+  case "b": { throw new Error('Not implemented yet: "b" case') }
+  case "c": { throw new Error('Not implemented yet: "c" case') }
+  // skip default
+}
+      `,
+            },
+          ],
+        },
+      ],
+      options: [
+        {
+          considerDefaultExhaustiveForUnions: false,
+          defaultCaseCommentPattern: '^skip\\sdefault',
+        },
+      ],
+    },
   ],
 });
diff --git a/packages/eslint-plugin/tests/schema-snapshots/switch-exhaustiveness-check.shot b/packages/eslint-plugin/tests/schema-snapshots/switch-exhaustiveness-check.shot