# function-paren-newline

在函数括号内强制执行一致的换行符

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

许多样式指南要求或禁止函数括号内的换行符。

# 规则详情

此规则在函数参数或参数的括号内强制执行一致的换行符。

# 选项

此规则有一个选项,可以是字符串或对象。

  • "always" 要求在所有函数括号内换行。
  • "never" 不允许在所有函数括号内换行。
  • 如果任何参数/参数之间有换行符,"multiline"(默认)需要在函数括号内换行。否则,它不允许换行。
  • "multiline-arguments"multiline 类似,但如果只有一个参数/参数,则允许在函数括号内进行换行。
  • "consistent" 要求每对括号一致地使用换行符。如果一对括号中的一个括号内有换行符,而另一个括号内没有,则会报告错误。
  • 如果参数/参数的数量至少为 value,则 { "minItems": value } 需要在函数括号内使用换行符。否则,它不允许换行。

示例配置:

{
  "rules": {
    "function-paren-newline": ["error", "never"]
  }
}
{
  "rules": {
    "function-paren-newline": ["error", { "minItems": 3 }]
  }
}

此规则使用 "always" 选项的错误代码示例:

/* eslint function-paren-newline: ["error", "always"] */

function foo(bar, baz) {}

var foo = function(bar, baz) {};

var foo = (bar, baz) => {};

foo(bar, baz);

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

/* eslint function-paren-newline: ["error", "always"] */

function foo(
  bar,
  baz
) {}

var foo = function(
  bar, baz
) {};

var foo = (
  bar,
  baz
) => {};

foo(
  bar,
  baz
);

此规则使用 "never" 选项的错误代码示例:

/* eslint function-paren-newline: ["error", "never"] */

function foo(
  bar,
  baz
) {}

var foo = function(
  bar, baz
) {};

var foo = (
  bar,
  baz
) => {};

foo(
  bar,
  baz
);

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

/* eslint function-paren-newline: ["error", "never"] */

function foo(bar, baz) {}

function foo(bar,
             baz) {}

var foo = function(bar, baz) {};

var foo = (bar, baz) => {};

foo(bar, baz);

foo(bar,
  baz);

此规则使用默认 "multiline" 选项的错误代码示例:

/* eslint function-paren-newline: ["error", "multiline"] */

function foo(bar,
  baz
) {}

var foo = function(
  bar, baz
) {};

var foo = (
  bar,
  baz) => {};

foo(bar,
  baz);

foo(
  function() {
    return baz;
  }
);

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

/* eslint function-paren-newline: ["error", "multiline"] */

function foo(bar, baz) {}

var foo = function(
  bar,
  baz
) {};

var foo = (bar, baz) => {};

foo(bar, baz, qux);

foo(
  bar,
  baz,
  qux
);

foo(function() {
  return baz;
});

此规则使用 "consistent" 选项的错误代码示例:

/* eslint function-paren-newline: ["error", "consistent"] */

function foo(bar,
  baz
) {}

var foo = function(bar,
  baz
) {};

var foo = (
  bar,
  baz) => {};

foo(
  bar,
  baz);

foo(
  function() {
    return baz;
  });

此规则使用 "consistent" 选项的正确代码示例:

/* eslint function-paren-newline: ["error", "consistent"] */

function foo(bar,
  baz) {}

var foo = function(bar, baz) {};

var foo = (
  bar,
  baz
) => {};

foo(
  bar, baz
);

foo(
  function() {
    return baz;
  }
);

此规则使用 "multiline-arguments" 选项的错误代码示例:

/* eslint function-paren-newline: ["error", "multiline-arguments"] */

function foo(bar,
  baz
) {}

var foo = function(bar,
  baz
) {};

var foo = (
  bar,
  baz) => {};

foo(
  bar,
  baz);

foo(
  bar, qux,
  baz
);

具有一致 "multiline-arguments" 选项的此规则的正确代码示例:

/* eslint function-paren-newline: ["error", "multiline-arguments"] */

function foo(
  bar,
  baz
) {}

var foo = function(bar, baz) {};

var foo = (
  bar
) => {};

foo(
  function() {
    return baz;
  }
);

此规则使用 { "minItems": 3 } 选项的错误代码示例:

/* eslint function-paren-newline: ["error", { "minItems": 3 }] */

function foo(
  bar,
  baz
) {}

function foo(bar, baz, qux) {}

var foo = function(
  bar, baz
) {};

var foo = (bar,
  baz) => {};

foo(bar,
  baz);

此规则使用 { "minItems": 3 } 选项的正确代码示例:

/* eslint function-paren-newline: ["error", { "minItems": 3 }] */

function foo(bar, baz) {}

var foo = function(
  bar,
  baz,
  qux
) {};

var foo = (
  bar, baz, qux
) => {};

foo(bar, baz);

foo(
  bar, baz, qux
);

# 何时不使用

如果不想在函数括号内强制执行一致的换行符,请不要打开此规则。

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