comma-spacing

强制逗号前后保持一致的间距

逗号周围的空格提高了项目列表的可读性。虽然大多数语言的风格指南都规定在逗号后添加空格，而不是在逗号前添加空格，但这取决于项目的偏好。

var foo = 1, bar = 2;
var foo = 1 ,bar = 2;
1
2

规则详情

此规则强制在变量声明、数组字面量、对象字面量、函数参数和序列中逗号前后保持一致的间距。

此规则在以下两种情况下不适用

• 两个逗号之间
• 在左方括号 [ 和逗号之间，以避免与 array-bracket-spacing 规则冲突
• 在逗号和右方括号 ] 之间，以避免与 array-bracket-spacing 规则冲突
• 在逗号和右大括号 } 之间，以避免与 object-curly-spacing 规则冲突
• 在逗号和右圆括号 ) 之间，以避免与 space-in-parens 规则冲突

选项

此规则有一个对象选项

• "before": false (默认) 不允许在逗号前有空格
• "before": true 要求在逗号前有一个或多个空格
• "after": true (默认) 要求在逗号后有一个或多个空格
• "after": false 不允许在逗号后有空格

after

以下是使用默认 { "before": false, "after": true } 选项时不正确代码的示例

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

var foo = 1 ,bar = 2;
var arr = [1 , 2];
var obj = {"foo": "bar" ,"baz": "qur"};
foo(a ,b);
new Foo(a ,b);
function baz(a ,b){}
a ,b
1
2
3
4
5
6
7
8
9

以下是使用默认 { "before": false, "after": true } 选项时正确代码的示例

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

var foo = 1, bar = 2
    , baz = 3;
var arr = [1, 2];
var arr = [1,, 3]
var obj = {"foo": "bar", "baz": "qur"};
foo(a, b);
new Foo(a, b);
function qur(a, b){}
a, b
1
2
3
4
5
6
7
8
9
10
11

以下是使用默认 { "before": false, "after": true } 选项时正确代码的其他示例

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

// this rule does not enforce spacing between two commas
var arr = [
    ,,
    , ,
];

// this rule does not enforce spacing after `[` and before `]`
var arr = [,];
var arr = [ , ];
var arr = [a, b,];
[,] = arr;
[ , ] = arr;
[a, b,] = arr;

// this rule does not enforce spacing before `}`
var obj = {x, y,};
var {z, q,} = obj;
import {foo, bar,} from "mod";

// this rule does not enforce spacing before `)`
foo(a, b,)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

before

以下是使用 { "before": true, "after": false } 选项时不正确代码的示例

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

var foo = 1, bar = 2;
var arr = [1 , 2];
var obj = {"foo": "bar", "baz": "qur"};
new Foo(a,b);
function baz(a,b){}
a, b
1
2
3
4
5
6
7
8

以下是使用 { "before": true, "after": false } 选项时正确代码的示例

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

var foo = 1 ,bar = 2 ,
    baz = true;
var arr = [1 ,2];
var arr = [1 ,,3]
var obj = {"foo": "bar" ,"baz": "qur"};
foo(a ,b);
new Foo(a ,b);
function qur(a ,b){}
a ,b
1
2
3
4
5
6
7
8
9
10
11

何时不使用

如果您的项目不遵循一致的逗号间距模式，请关闭此规则。

相关规则

• array-bracket-spacing
• comma-style
• object-curly-spacing
• space-in-brackets
• space-in-parens
• space-infix-ops
• space-after-keywords
• space-unary-ops
• space-return-throw-case

版本

此规则在 ESLint v0.9.0 中引入。

延伸阅读

JavaScript 编程语言的代码约定
www.crockford.com

Dojo Style Guide — The Dojo Toolkit - 参考指南
dojotoolkit.org

资源

• 规则来源
• 测试来源