newline-per-chained-call

要求方法链中每次调用后都换行

单行上没有换行的链式方法调用更难阅读，因此一些开发者在链中每次方法调用后都放置一个换行符，使其更易读和易于维护。

让我们看看以下完全有效（但单行）的代码。

d3.select("body").selectAll("p").data([4, 8, 15, 16, 23, 42 ]).enter().append("p").text(function(d) { return "I'm number " + d + "!"; });
1

然而，通过适当的换行，它变得易于阅读和理解。看看下面用换行符分隔每次调用的相同代码。

d3
    .select("body")
    .selectAll("p")
    .data([
        4,
        8,
        15,
        16,
        23,
        42
    ])
    .enter()
    .append("p")
    .text(function (d) {
        return "I'm number " + d + "!";
    });
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

支持这种风格的另一个论点是，当方法链中的某些内容发生更改时，它可以提高差异的清晰度

不太清晰

-d3.select("body").selectAll("p").style("color", "white");
+d3.select("body").selectAll("p").style("color", "blue");
1
2

更清晰

d3
    .select("body")
    .selectAll("p")
-    .style("color", "white");
+    .style("color", "blue");
1
2
3
4
5

规则详情

此规则要求在方法链或深层成员访问中的每次调用后都换行。诸如 instance[something] 之类的计算属性访问被排除在外。

选项

此规则有一个对象选项

• "ignoreChainWithDepth"（默认值：2）允许链的最大深度为指定深度。

ignoreChainWithDepth

此规则的不正确代码示例，默认选项为 { "ignoreChainWithDepth": 2 }

/*eslint newline-per-chained-call: ["error", { "ignoreChainWithDepth": 2 }]*/

_.chain({}).map(foo).filter(bar).value();

// Or
_.chain({}).map(foo).filter(bar);

// Or
_
  .chain({}).map(foo)
  .filter(bar);

// Or
obj.method().method2().method3();
1
2
3
4
5
6
7
8
9
10
11
12
13
14

此规则的正确代码示例，默认选项为 { "ignoreChainWithDepth": 2 }

/*eslint newline-per-chained-call: ["error", { "ignoreChainWithDepth": 2 }]*/

_
  .chain({})
  .map(foo)
  .filter(bar)
  .value();

// Or
_
  .chain({})
  .map(foo)
  .filter(bar);

// Or
_.chain({})
  .map(foo)
  .filter(bar);

// Or
obj
  .prop
  .method().prop;

// Or
obj
  .prop.method()
  .method2()
  .method3().prop;
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

何时不使用

如果你有冲突的规则，或者当你对单行链式调用感到满意时，你可以安全地关闭此规则。

版本

此规则在 ESLint v2.0.0-rc.0 中引入。

资源

• 规则来源
• 测试来源