逗号悬垂

要求或禁止尾随逗号

🔧

此规则报告的一些问题可以通过 --fix 命令行选项自动修复

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

根据 ECMAScript 5（以及 ECMAScript 3！）规范，对象字面量中的尾随逗号是有效的。但是，IE8（不在 IE8 文档模式下）及以下版本在遇到 JavaScript 中的尾随逗号时会抛出错误。

var foo = {
    bar: "baz",
    qux: "quux",
};
1
2
3
4

尾随逗号简化了向对象和数组添加和删除项的操作，因为只需修改您正在修改的行即可。另一个支持尾随逗号的论据是，它提高了在从对象或数组中添加或删除项时的差异的清晰度

不够清晰

 var foo = {
-    bar: "baz",
-    qux: "quux"
+    bar: "baz"
 };
1
2
3
4
5

更清晰

 var foo = {
     bar: "baz",
-    qux: "quux",
 };
1
2
3
4

规则详情

此规则强制在对象和数组字面量中一致使用尾随逗号。

选项

此规则具有字符串选项或对象选项

{
    "comma-dangle": ["error", "never"],
    // or
    "comma-dangle": ["error", {
        "arrays": "never",
        "objects": "never",
        "imports": "never",
        "exports": "never",
        "functions": "never"
    }]
}
1
2
3
4
5
6
7
8
9
10
11

"never"（默认）禁止尾随逗号
"always" 要求尾随逗号
"always-multiline" 要求尾随逗号，当最后一个元素或属性在与结束 ] 或 } 不同的一行上时，并且禁止尾随逗号，当最后一个元素或属性在与结束 ] 或 } 相同的一行上时
"only-multiline" 允许（但不强制要求）尾随逗号，当最后一个元素或属性在与结束 ] 或 } 不同的一行上时，并且禁止尾随逗号，当最后一个元素或属性在与结束 ] 或 } 相同的一行上时

您还可以使用对象选项为每种语法类型配置此规则。以下每个选项都可以设置为 "never"、"always"、"always-multiline"、"only-multiline" 或 "ignore"。除非另有说明，否则每个选项的默认值为 "never"。

arrays 用于数组字面量和解构的数组模式。（例如 let [a,] = [1,];）
objects 用于对象字面量和解构的对象模式。（例如 let {a,} = {a: 1};）
imports 用于 ES 模块的导入声明。（例如 import {a,} from "foo";）
exports 用于 ES 模块的导出声明。（例如 export {a,};）
functions 用于函数声明和函数调用。（例如 (function(a,){ })(b,);）
- functions 仅应在 lint ECMAScript 2017 或更高版本时启用。

never

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

在游乐场中打开

/*eslint comma-dangle: ["error", "never"]*/

var foo = {
    bar: "baz",
    qux: "quux",
};

var arr = [1,2,];

foo({
  bar: "baz",
  qux: "quux",
});
1
2
3
4
5
6
7
8
9
10
11
12
13

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

在游乐场中打开

/*eslint comma-dangle: ["error", "never"]*/

var foo = {
    bar: "baz",
    qux: "quux"
};

var arr = [1,2];

foo({
  bar: "baz",
  qux: "quux"
});
1
2
3
4
5
6
7
8
9
10
11
12
13

always

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

在游乐场中打开

/*eslint comma-dangle: ["error", "always"]*/

var foo = {
    bar: "baz",
    qux: "quux"
};

var arr = [1,2];

foo({
  bar: "baz",
  qux: "quux"
});
1
2
3
4
5
6
7
8
9
10
11
12
13

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

在游乐场中打开

/*eslint comma-dangle: ["error", "always"]*/

var foo = {
    bar: "baz",
    qux: "quux",
};

var arr = [1,2,];

foo({
  bar: "baz",
  qux: "quux",
});
1
2
3
4
5
6
7
8
9
10
11
12
13

always-multiline

使用 "always-multiline" 选项对此规则的不正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", "always-multiline"]*/

var foo = {
    bar: "baz",
    qux: "quux"
};

var foo = { bar: "baz", qux: "quux", };

var arr = [1,2,];

var arr = [1,
    2,];

var arr = [
    1,
    2
];

foo({
  bar: "baz",
  qux: "quux"
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

使用 "always-multiline" 选项对此规则的正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", "always-multiline"]*/

var foo = {
    bar: "baz",
    qux: "quux",
};

var foo = {bar: "baz", qux: "quux"};
var arr = [1,2];

var arr = [1,
    2];

var arr = [
    1,
    2,
];

foo({
  bar: "baz",
  qux: "quux",
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

only-multiline

使用 "only-multiline" 选项对此规则的不正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", "only-multiline"]*/

var foo = { bar: "baz", qux: "quux", };

var arr = [1,2,];

var arr = [1,
    2,];

1
2
3
4
5
6
7
8
9

使用 "only-multiline" 选项对此规则的正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", "only-multiline"]*/

var foo = {
    bar: "baz",
    qux: "quux",
};

var foo = {
    bar: "baz",
    qux: "quux"
};

var foo = {bar: "baz", qux: "quux"};
var arr = [1,2];

var arr = [1,
    2];

var arr = [
    1,
    2,
];

var arr = [
    1,
    2
];

foo({
  bar: "baz",
  qux: "quux",
});

foo({
  bar: "baz",
  qux: "quux"
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

functions

使用 {"functions": "never"} 选项对此规则的不正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", {"functions": "never"}]*/

function foo(a, b,) {
}

foo(a, b,);
new foo(a, b,);
1
2
3
4
5
6
7

使用 {"functions": "never"} 选项对此规则的正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", {"functions": "never"}]*/

function foo(a, b) {
}

foo(a, b);
new foo(a, b);
1
2
3
4
5
6
7

使用 {"functions": "always"} 选项对此规则的不正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", {"functions": "always"}]*/

function foo(a, b) {
}

foo(a, b);
new foo(a, b);
1
2
3
4
5
6
7

使用 {"functions": "always"} 选项对此规则的正确代码示例

在游乐场中打开

/*eslint comma-dangle: ["error", {"functions": "always"}]*/

function foo(a, b,) {
}

foo(a, b,);
new foo(a, b,);
1
2
3
4
5
6
7

何时不使用它

如果您不关心悬垂逗号，可以关闭此规则。

版本

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

资源

编辑此页面