# newline-per-chained-call

在方法链中的每次调用后都需要换行符

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

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

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

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

但是,通过适当的新行,它变得易于阅读和理解。查看下面编写的相同代码,每次调用后都有换行符。

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

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

不太晰:

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

更清晰:

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

# 规则详情

此规则需要在方法链或深度成员访问中的每次调用后换行。不包括 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();

此规则使用默认 { "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;

# 何时不使用

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

Last Updated: 5/13/2023, 8:55:38 PM