跳至内容

@stylistic/js/

newline-per-chained-call

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

让我们看一下以下完全有效的(但单行)代码。

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

但是,通过适当的换行符,它变得易于阅读和理解。请查看下面用换行符书写的相同代码。

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

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

不太清晰

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

更清晰

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

规则详细信息

此规则要求在方法链或深度成员访问中的每个调用后换行。计算属性访问(如 instance[something])除外。

选项

此规则有一个对象选项

  • "ignoreChainWithDepth"(默认值:2)允许链式调用深度不超过指定深度。

ignoreChainWithDepth

使用默认 { "ignoreChainWithDepth": 2 } 选项时,此规则的不正确代码示例

js
/*eslint @stylistic/js/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
();
incorrect

使用默认 { "ignoreChainWithDepth": 2 } 选项时,此规则的正确代码示例

js
/*eslint @stylistic/js/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;
correct

何时不使用它

如果您有冲突的规则,或者您不介意在一行上进行链式调用,您可以安全地关闭此规则。