function-paren-newline

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

🔧

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

此规则在 ESLint v8.53.0 中已**弃用**。请使用对应的规则在 @stylistic/eslint-plugin-js 中。

许多风格指南要求或禁止在函数括号内换行。

规则详细信息

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

选项

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

"always" 要求在所有函数括号内换行。
"never" 禁止在所有函数括号内换行。
"multiline"（默认）如果任何参数/参数之间存在换行符，则要求在函数括号内换行。否则，它禁止换行。
"multiline-arguments" 的工作原理类似于 multiline，但如果只有一个参数/参数，则允许在函数括号内换行。
"consistent" 要求每对括号内换行符的使用保持一致。如果一对括号中一个括号内有换行符，而另一个括号内没有，则会报告错误。
{ "minItems": value } 如果参数/参数的数量至少为 value，则要求在函数括号内换行。否则，它禁止换行。

示例配置

{
  "rules": {
    "function-paren-newline": ["error", "never"]
  }
}
1
2
3
4
5

{
  "rules": {
    "function-paren-newline": ["error", { "minItems": 3 }]
  }
}
1
2
3
4
5

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

在游乐场中打开

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

function foo(bar, baz) {}

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

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

foo(bar, baz);
1
2
3
4
5
6
7
8
9

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

在游乐场中打开

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

function foo(
  bar,
  baz
) {}

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

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

foo(
  bar,
  baz
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

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

在游乐场中打开

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

function foo(
  bar,
  baz
) {}

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

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

foo(
  bar,
  baz
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

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

在游乐场中打开

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

function foo(bar, baz) {}

function qux(bar,
             baz) {}

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

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

foo(bar, baz);

foo(bar,
  baz);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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

在游乐场中打开

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

function foo(bar,
  baz
) {}

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

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

foo(bar,
  baz);

foo(
  function() {
    return baz;
  }
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

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

在游乐场中打开

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

function foo(bar, baz) {}

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

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

foo(bar, baz, qux);

foo(
  bar,
  baz,
  qux
);

foo(function() {
  return baz;
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

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

在游乐场中打开

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

function foo(bar,
  baz
) {}

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

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

foo(
  bar,
  baz);

foo(
  function() {
    return baz;
  });
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

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

在游乐场中打开

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

function foo(bar,
  baz) {}

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

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

foo(
  bar, baz
);

foo(
  function() {
    return baz;
  }
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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

在游乐场中打开

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

function foo(bar,
  baz
) {}

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

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

foo(
  bar,
  baz);

foo(
  bar, qux,
  baz
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

使用一致的 "multiline-arguments" 选项时，此规则的正确代码示例

在游乐场中打开

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

function foo(
  bar,
  baz
) {}

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

var qux = (
  bar
) => {};

foo(
  function() {
    return baz;
  }
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

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

在游乐场中打开

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

function foo(
  bar,
  baz
) {}

function foobar(bar, baz, qux) {}

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

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

foo(
  bar,
  baz
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

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

在游乐场中打开

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

function foo(bar, baz) {}

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

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

foo(bar, baz);

foo(
  bar, baz, qux
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

何时不使用它

如果不想强制在函数括号内使用一致的换行符，请不要启用此规则。

版本

此规则在 ESLint v4.6.0 中引入。

资源

编辑此页面