mirror of
https://git.proxmox.com/git/pve-eslint
synced 2025-10-06 02:14:51 +00:00
eb39fafa4f
includes a (minimal) working wrapper Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
81 lines
1.7 KiB
Markdown
81 lines
1.7 KiB
Markdown
# Enforce spacing around colons of switch statements (switch-colon-spacing)
|
|
|
|
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.
|
|
|
|
```json
|
|
{
|
|
"switch-colon-spacing": ["error", {"after": true, "before": false}]
|
|
}
|
|
```
|
|
|
|
- `"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:
|
|
|
|
```js
|
|
/*eslint switch-colon-spacing: "error"*/
|
|
|
|
switch (a) {
|
|
case 0 :break;
|
|
default :foo();
|
|
}
|
|
```
|
|
|
|
Examples of **correct** code for this rule:
|
|
|
|
```js
|
|
/*eslint switch-colon-spacing: "error"*/
|
|
|
|
switch (a) {
|
|
case 0: foo(); break;
|
|
case 1:
|
|
bar();
|
|
break;
|
|
default:
|
|
baz();
|
|
break;
|
|
}
|
|
```
|
|
|
|
Examples of **incorrect** code for this rule with `{"after": false, "before": true}` option:
|
|
|
|
```js
|
|
/*eslint switch-colon-spacing: ["error", {"after": false, "before": true}]*/
|
|
|
|
switch (a) {
|
|
case 0: break;
|
|
default: foo();
|
|
}
|
|
```
|
|
|
|
Examples of **correct** code for this rule with `{"after": false, "before": true}` option:
|
|
|
|
```js
|
|
/*eslint switch-colon-spacing: ["error", {"after": false, "before": true}]*/
|
|
|
|
switch (a) {
|
|
case 0 :foo(); break;
|
|
case 1 :
|
|
bar();
|
|
break;
|
|
default :
|
|
baz();
|
|
break;
|
|
}
|
|
```
|
|
|
|
## 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.
|