逗号风格

强制使用一致的逗号风格

此规则在 ESLint v8.53.0 中已弃用。请使用 相应的规则 在 @stylistic/eslint-plugin-js 中。

逗号风格规则强制执行逗号分隔列表的风格。JavaScript 中主要使用两种逗号风格

• 标准风格，其中逗号放在当前行的末尾
• 逗号优先风格，其中逗号放在下一行的开头

使用逗号优先风格的理由之一是它可以帮助跟踪丢失的逗号和尾随逗号。这些是有问题的，因为变量声明中缺少逗号会导致全局变量泄漏，而尾随逗号会导致旧版 IE 中的错误。

规则详细信息

此规则强制在数组文字、对象文字和变量声明中使用一致的逗号风格。

此规则不适用于以下两种情况之一

• 逗号之前和之后有换行符（孤单逗号）
• 单行数组文字、对象文字和变量声明

选项

此规则有一个字符串选项

• "last"（默认）要求在数组元素、对象属性或变量声明之后和同一行上添加逗号
• "first" 要求在数组元素、对象属性或变量声明之前和同一行上添加逗号

此规则还接受一个额外的 exceptions 对象

• "exceptions" 的属性名称对应于 JavaScript 代码抽象语法树 (AST) 中的节点类型

  • "ArrayExpression": true 忽略数组文字中的逗号风格
  • "ArrayPattern": true 忽略解构中的数组模式中的逗号风格
  • "ArrowFunctionExpression": true 忽略箭头函数表达式参数中的逗号风格
  • "CallExpression": true 忽略函数调用参数中的逗号风格
  • "FunctionDeclaration": true 忽略函数声明参数中的逗号风格
  • "FunctionExpression": true 忽略函数表达式参数中的逗号风格
  • "ImportDeclaration": true 忽略导入声明的指定者中的逗号风格
  • "ObjectExpression": true 忽略对象文字中的逗号风格
  • "ObjectPattern": true 忽略解构中的对象模式中的逗号风格
  • "VariableDeclaration": true 忽略变量声明中的逗号风格
  • "NewExpression": true 忽略构造函数表达式参数中的逗号风格

确定由 ESTree 定义的节点类型的一种方法是使用 AST 浏览器 以及 espree 解析器。

最后一个

此规则使用默认的 "last" 选项的不正确代码示例

/*eslint comma-style: ["error", "last"]*/

var foo = 1
,
bar = 2;

var foo = 1
  , bar = 2;

var foo = ["apples"
           , "oranges"];

function baz() {
    return {
        "a": 1
        ,"b:": 2
    };
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

此规则使用默认的 "last" 选项的正确代码示例

/*eslint comma-style: ["error", "last"]*/

var foo = 1, bar = 2;

var foo = 1,
    bar = 2;

var foo = ["apples",
           "oranges"];

function baz() {
    return {
        "a": 1,
        "b:": 2
    };
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

第一个

此规则使用 "first" 选项的不正确代码示例

/*eslint comma-style: ["error", "first"]*/

var foo = 1,
    bar = 2;

var foo = ["apples",
           "oranges"];

function baz() {
    return {
        "a": 1,
        "b:": 2
    };
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

此规则使用 "first" 选项的正确代码示例

/*eslint comma-style: ["error", "first"]*/

var foo = 1, bar = 2;

var foo = 1
    ,bar = 2;

var foo = ["apples"
          ,"oranges"];

function baz() {
    return {
        "a": 1
        ,"b:": 2
    };
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

例外

一个用例是在仅 var 语句中强制执行逗号风格。

此规则使用示例 "first", { "exceptions": { … } } 选项的不正确代码示例

/*eslint comma-style: ["error", "first", { "exceptions": { "ArrayExpression": true, "ObjectExpression": true } }]*/

var o = {},
    a = [];
1
2
3
4

此规则使用示例 "first", { "exceptions": { … } } 选项的正确代码示例

/*eslint comma-style: ["error", "first", { "exceptions": { "ArrayExpression": true, "ObjectExpression": true } }]*/

var o = {fst:1,
         snd: [1,
               2]}
  , a = [];
1
2
3
4
5
6

何时不使用它

如果您的项目不关心强制执行一致的逗号风格，则可以安全地关闭此规则。

相关规则

• 运算符换行

版本

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

进一步阅读

JavaScript 中列表和对象文字的更好的编码约定
gist.github.com

资源

• 规则源
• 测试源