非常教程

Eslint参考手册

规则 | Rules

comma-dangle

--fix命令行上的选项可以自动修复一些被这条规则反映的问题。

根据ECMAScript 5(和ECMAScript 3!)规范,对象文字中的尾随逗号是有效的。但是,IE8(当不在IE8文档模式下)和下面的代码在JavaScript中遇到尾随逗号时会引发错误。

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

尾随逗号可以简化向对象和数组中添加和删除项目的操作,因为只有您正在修改的行必须被触及。支持尾随逗号的另一个论据是,当从对象或数组中添加或删除项目时,它提高了差异的清晰度:

Less clear:

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

更清晰:

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

规则细节

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

选项

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

{
    "comma-dangle": ["error", "never"],
    // or
    "comma-dangle": ["error", {
        "arrays": "never",
        "objects": "never",
        "imports": "never",
        "exports": "never",
        "functions": "ignore"
    }]
}
  • "never" (默认)不允许尾随逗号
  • "always" 需要尾随逗号
  • "always-multiline"需要尾随逗号时的最后一个元素或属性是一个不同的线比所述封闭]}和不允许尾随逗号时的最后一个元素或属性是基于相同行的闭合]}
  • "only-multiline"允许(但不要求)后逗号时的最后一个元素或属性是一个不同的线比所述封闭]}和不允许尾随逗号时的最后一个元素或属性是基于相同行的闭合]}

自ECMAScript 2017以来,函数声明和函数调用中的尾随逗号是有效的语法; 但是,字符串选项不检查这些情况的向后兼容性。

您还可以使用对象选项为每种语法类型配置此规则。下列选项每一个都可以被设置为"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被设置为"ignore"默认情况下以字符串选项的一致性。
    • functions 只能在LINTING ECMAScript 2017或更高版本时启用。

决不

此规则的默认代码错误代码示例"never"

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

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

var arr = [1,2,];

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

具有默认选项的此规则的正确代码示例"never"

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

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

var arr = [1,2];

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

总是

此规则的错误代码示例包含以下"always"选项:

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

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

var arr = [1,2];

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

此规则的正确代码示例包含以下"always"选项:

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

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

var arr = [1,2,];

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

总是多

此规则的错误代码示例包含以下"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"
});

此规则的正确代码示例包含以下"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",
});

只有-多

此规则的错误代码示例包含以下"only-multiline"选项:

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

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

var arr = [1,2,];

var arr = [1,
    2,];

此规则的正确代码示例包含以下"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"
});

功能

此规则的错误代码示例包含以下{"functions": "never"}选项:

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

function foo(a, b,) {
}

foo(a, b,);
new foo(a, b,);

此规则的正确代码示例包含以下{"functions": "never"}选项:

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

function foo(a, b) {
}

foo(a, b);
new foo(a, b);

此规则的错误代码示例包含以下{"functions": "always"}选项:

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

function foo(a, b) {
}

foo(a, b);
new foo(a, b);

此规则的正确代码示例包含以下{"functions": "always"}选项:

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

function foo(a, b,) {
}

foo(a, b,);
new foo(a, b,);

何时不使用它

如果你不关注悬摆逗号,你可以关闭这个规则。

该规则在ESLint 0.16.0中引入。

资源

  • 规则来源
  • 文档来源

规则 | Rules相关

1.accessor-pairs
2.array-bracket-newline
3.array-bracket-spacing
4.array-callback-return
5.array-element-newline
6.arrow-body-style
7.arrow-parens
8.arrow-spacing
9.block-scoped-var
10.block-spacing
11.brace-style
12.callback-return
13.camelcase
14.capitalized-comments
15.class-methods-use-this
16.comma-spacing
17.comma-style
18.complexity
19.computed-property-spacing
20.consistent-return
21.consistent-this
22.constructor-super
23.curly
24.default-case
25.dot-location
26.dot-notation
27.eol-last
28.eqeqeq
29.for-direction
30.func-call-spacing
31.func-name-matching
32.func-names
33.func-style
34.function-paren-newline
35.generator-star
36.generator-star-spacing
37.getter-return
38.global-require
39.global-strict
40.guard-for-in
41.handle-callback-err
42.id-blacklist
43.id-length
44.id-match
45.implicit-arrow-linebreak
46.indent
47.indent-legacy
48.init-declarations
49.jsx-quotes
50.key-spacing
51.keyword-spacing
52.line-comment-position
53.linebreak-style
54.lines-around-comment
55.lines-around-directive
56.lines-between-class-members
57.max-depth
58.max-len
59.max-lines
60.max-nested-callbacks
61.max-params
62.max-statements
63.max-statements-per-line
64.multiline-comment-style
65.multiline-ternary
66.new-cap
67.new-parens
68.newline-after-var
69.newline-before-return
70.newline-per-chained-call
71.no-alert
72.no-array-constructor
73.no-arrow-condition
74.no-await-in-loop
75.no-bitwise
76.no-buffer-constructor
77.no-caller
78.no-case-declarations
79.no-catch-shadow
80.no-class-assign
81.no-comma-dangle
82.no-compare-neg-zero
83.no-cond-assign
84.no-confusing-arrow
85.no-console
86.no-const-assign
87.no-constant-condition
88.no-continue
89.no-control-regex
90.no-debugger
91.no-delete-var
92.no-div-regex
93.no-dupe-args
94.no-dupe-class-members
95.no-dupe-keys
96.no-duplicate-case
97.no-duplicate-imports
98.no-else-return
99.no-empty
100.no-empty-character-class
Eslint

ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。

主页 https://eslint.org/
源码 https://github.com/eslint/eslint
发布版本 4.12.0

Eslint目录

1.指南 | Guide
2.规则 | Rules