跳至内容

@stylistic/js/

space-before-function-paren

在格式化函数时,函数名或 function 关键字与左括号之间允许有空格。命名函数需要在 function 关键字和函数名之间留一个空格,但匿名函数不需要空格。例如

js
function withoutSpace(x) {
    // ...
}

function withSpace (x) {
    // ...
}

var anonymousWithoutSpace = function() {};

var anonymousWithSpace = function () {};

一些风格指南可能要求在匿名函数的 function 关键字后留一个空格,而另一些则指定不留空格。类似地,函数名后的空格也可能需要或不需要。

规则详情

此规则旨在强制在函数括号前保持一致的空格,因此,只要空格与指定的偏好不匹配,就会发出警告。

选项

此规则有一个字符串选项或一个对象选项

js
{
    "space-before-function-paren": ["error", "always"],
    // or
    "space-before-function-paren": ["error", {
        "anonymous": "always",
        "named": "always",
        "asyncArrow": "always"
    }],
}
  • always(默认)要求在参数的 ( 之前留一个空格。
  • never 不允许在参数的 ( 之前留任何空格。

字符串选项不检查异步箭头函数表达式,以保持向后兼容性。

您还可以为每种类型的函数使用单独的选项。以下每个选项都可以设置为 "always""never""ignore"。默认值为 "always"

  • anonymous 用于匿名函数表达式(例如 function () {})。
  • named 用于命名函数表达式(例如 function foo () {})。
  • asyncArrow 用于异步箭头函数表达式(例如 async () => {})。

"always"

使用默认 "always" 选项时,此规则的不正确代码示例

js
/*eslint @stylistic/js/space-before-function-paren: "error"*/
/*eslint-env es6*/

function foo
(
) {
// ... } var bar = function
(
) {
// ... }; var bar = function foo
(
) {
// ... }; class Foo { constructor
(
) {
// ... } } var baz = { bar
(
) {
// ... } }; var baz = async
(
) => 1
incorrect

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

js
/*eslint @stylistic/js/space-before-function-paren: "error"*/
/*eslint-env es6*/

function foo () {
    // ...
}

var bar = function () {
    // ...
};

var bar = function foo () {
    // ...
};

class Foo {
    constructor () {
        // ...
    }
}

var baz = {
    bar () {
        // ...
    }
};

var baz = async () => 1
correct

"never"

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

js
/*eslint @stylistic/js/space-before-function-paren: ["error", "never"]*/
/*eslint-env es6*/

function foo
() {
// ... } var bar = function
() {
// ... }; var bar = function foo
() {
// ... }; class Foo { constructor
() {
// ... } } var baz = { bar
() {
// ... } }; var baz = async
() => 1
incorrect

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

js
/*eslint @stylistic/js/space-before-function-paren: ["error", "never"]*/
/*eslint-env es6*/

function foo() {
    // ...
}

var bar = function() {
    // ...
};

var bar = function foo() {
    // ...
};

class Foo {
    constructor() {
        // ...
    }
}

var baz = {
    bar() {
        // ...
    }
};

var baz = async() => 1
correct

{"anonymous": "always", "named": "never", "asyncArrow": "always"}

使用 {"anonymous": "always", "named": "never", "asyncArrow": "always"} 选项时,此规则的不正确代码示例

js
/*eslint @stylistic/js/space-before-function-paren: ["error", {"anonymous": "always", "named": "never", "asyncArrow": "always"}]*/
/*eslint-env es6*/

function foo
() {
// ... } var bar = function
(
) {
// ... }; class Foo { constructor
() {
// ... } } var baz = { bar
() {
// ... } }; var baz = async
(
a) => await a
incorrect

使用 {"anonymous": "always", "named": "never", "asyncArrow": "always"} 选项时,此规则的正确代码示例

js
/*eslint @stylistic/js/space-before-function-paren: ["error", {"anonymous": "always", "named": "never", "asyncArrow": "always"}]*/
/*eslint-env es6*/

function foo() {
    // ...
}

var bar = function () {
    // ...
};

class Foo {
    constructor() {
        // ...
    }
}

var baz = {
    bar() {
        // ...
    }
};

var baz = async (a) => await a
correct

{"anonymous": "never", "named": "always"}

此规则使用 {"anonymous": "never", "named": "always"} 选项时,**错误** 代码示例

js
/*eslint @stylistic/js/space-before-function-paren: ["error", { "anonymous": "never", "named": "always" }]*/
/*eslint-env es6*/

function foo
(
) {
// ... } var bar = function
() {
// ... }; class Foo { constructor
(
) {
// ... } } var baz = { bar
(
) {
// ... } };
incorrect

此规则使用 {"anonymous": "never", "named": "always"} 选项时,**正确** 代码示例

js
/*eslint @stylistic/js/space-before-function-paren: ["error", { "anonymous": "never", "named": "always" }]*/
/*eslint-env es6*/

function foo () {
    // ...
}

var bar = function() {
    // ...
};

class Foo {
    constructor () {
        // ...
    }
}

var baz = {
    bar () {
        // ...
    }
};
correct

{"anonymous": "ignore", "named": "always"}

此规则使用 {"anonymous": "ignore", "named": "always"} 选项时,**错误** 代码示例

js
/*eslint @stylistic/js/space-before-function-paren: ["error", { "anonymous": "ignore", "named": "always" }]*/
/*eslint-env es6*/

function foo
(
) {
// ... } class Foo { constructor
(
) {
// ... } } var baz = { bar
(
) {
// ... } };
incorrect

此规则使用 {"anonymous": "ignore", "named": "always"} 选项时,**正确** 代码示例

js
/*eslint @stylistic/js/space-before-function-paren: ["error", { "anonymous": "ignore", "named": "always" }]*/
/*eslint-env es6*/

var bar = function() {
    // ...
};

var bar = function () {
    // ...
};

function foo () {
    // ...
}

class Foo {
    constructor () {
        // ...
    }
}

var baz = {
    bar () {
        // ...
    }
};
correct

何时不使用它

如果您不关心函数括号前空格的一致性,可以关闭此规则。