useExhaustiveSwitchCases

JavaScript (and super languages)

Summary

Rule available since: v2.0.0
Diagnostic Category: lint/nursery/useExhaustiveSwitchCases
This rule has an unsafe fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- project
Sources:
- Same as @typescript-eslint/switch-exhaustiveness-check

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useExhaustiveSwitchCases": "error"
6
      }
7
    }
8
  }
9
}

Description

Require switch-case statements to be exhaustive.

When working with union types in TypeScript, it’s common to want to write a switch statement intended to contain a case for each possible variant. However, if the union type changes, it’s easy to forget to modify the cases to account for any new types.

This rule reports when a switch statement over a value typed as a union of literals lacks a case for any of those literal types and does not have a default clause.

Examples

Invalid

1
type Day =
2
  | 'Monday'
3
  | 'Tuesday'
4
  | 'Wednesday'
5
  | 'Thursday'
6
  | 'Friday'
7
  | 'Saturday'
8
  | 'Sunday';
9

10
declare const day: Day;
11
let result = 0;
12

13
switch (day) {
14
  case 'Monday':
15
    result = 1;
16
    break;
17
}

/invalid.ts:13:1 lint/nursery/useExhaustiveSwitchCases  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ The switch statement is not exhaustive.
  
    11 │ let result = 0;
    12 │ 
  > 13 │ switch (day) {
       │ ^^^^^^^^^^^^^^
  > 14 │   case ‘Monday’:
  > 15 │     result = 1;
  > 16 │     break;
  > 17 │ }
       │ ^
    18 │ 
  
  ℹ Some variants of the union type are not handled here.
  
  ℹ These cases are missing:
  
  - “Tuesday”
  - “Wednesday”
  - “Thursday”
  - “Friday”
  - “Saturday”
  - “Sunday”
  
  ℹ Unsafe fix: Add the missing cases to the switch statement.
  
    14 14 │     case ‘Monday’:
    15 15 │       result = 1;
    16    │ - ····break;
       16 │ + ····break;
       17 │ + ··case·“Tuesday”:·throw·new·Error(“TODO:·Not·implemented·yet”);
       18 │ + ··case·“Wednesday”:·throw·new·Error(“TODO:·Not·implemented·yet”);
       19 │ + ··case·“Thursday”:·throw·new·Error(“TODO:·Not·implemented·yet”);
       20 │ + ··case·“Friday”:·throw·new·Error(“TODO:·Not·implemented·yet”);
       21 │ + ··case·“Saturday”:·throw·new·Error(“TODO:·Not·implemented·yet”);
       22 │ + ··case·“Sunday”:·throw·new·Error(“TODO:·Not·implemented·yet”);
    17 23 │   }
    18 24 │

Valid

1
type Day =
2
  | 'Monday'
3
  | 'Tuesday'
4
  | 'Wednesday'
5
  | 'Thursday'
6
  | 'Friday'
7
  | 'Saturday'
8
  | 'Sunday';
9

10
declare const day: Day;
11
let result = 0;
12

13
switch (day) {
14
  case 'Monday':
15
    result = 1;
16
    break;
17
  case 'Tuesday':
18
    result = 2;
19
    break;
20
  case 'Wednesday':
21
    result = 3;
22
    break;
23
  case 'Thursday':
24
    result = 4;
25
    break;
26
  case 'Friday':
27
    result = 5;
28
    break;
29
  case 'Saturday':
30
    result = 6;
31
    break;
32
  case 'Sunday':
33
    result = 7;
34
    break;
35
}