switch-colon-spacing

Enforce spacing around colons of switch statements

This rule was deprecated in ESLint v8.53.0. Please use the corresponding rule in @stylistic/eslint-plugin-js.

Spacing around colons improves readability of case/default clauses.

Rule Details

This rule controls spacing around colons of case and default clauses in switch statements. This rule does the check only if the consecutive tokens exist on the same line.

This rule has 2 options that are boolean value.

{
    "switch-colon-spacing": ["error", {"after": true, "before": false}]
}
1
2
3

• "after": true (Default) requires one or more spaces after colons.
• "after": false disallows spaces after colons.
• "before": true requires one or more spaces before colons.
• "before": false (Default) disallows before colons.

Examples of incorrect code for this rule:

/*eslint switch-colon-spacing: "error"*/

switch (a) {
    case 0 :break;
    default :foo();
}
1
2
3
4
5
6

Examples of correct code for this rule:

/*eslint switch-colon-spacing: "error"*/

switch (a) {
    case 0: foo(); break;
    case 1:
        bar();
        break;
    default:
        baz();
        break;
}
1
2
3
4
5
6
7
8
9
10
11

Examples of incorrect code for this rule with {"after": false, "before": true} option:

/*eslint switch-colon-spacing: ["error", {"after": false, "before": true}]*/

switch (a) {
    case 0: break;
    default: foo();
}
1
2
3
4
5
6

Examples of correct code for this rule with {"after": false, "before": true} option:

/*eslint switch-colon-spacing: ["error", {"after": false, "before": true}]*/

switch (a) {
    case 0 :foo(); break;
    case 1 :
        bar();
        break;
    default :
        baz();
        break;
}
1
2
3
4
5
6
7
8
9
10
11

When Not To Use It

If you don’t want to notify spacing around colons of switch statements, then it’s safe to disable this rule.

Version

This rule was introduced in ESLint v4.0.0-beta.0.

Resources

• Rule source
• Tests source