版本

space-before-function-paren

强制在 function 定义的开括号前保持一致的空格

🔧 可修复

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

重要

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

了解更多

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

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

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

var anonymousWithoutSpace = function() {};

var anonymousWithSpace = function () {};

风格指南可能要求匿名函数的 function 关键字后有一个空格,而其他指南则指定没有空格。同样,函数名后的空格可能是必需的,也可能不是必需的。

规则详情

此规则旨在强制函数括号前保持一致的空格,因此,当空格不符合指定的偏好时,将会发出警告。

选项

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

{
    "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” 选项时,此规则的 错误 代码示例

在 Playground 中打开
/*eslint space-before-function-paren: "error"*/

function foo() {
    // ...
}

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

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

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

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

var baz = async() => 1

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

在 Playground 中打开
/*eslint space-before-function-paren: "error"*/

function foo () {
    // ...
}

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

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

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

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

var baz = async () => 1

“never”

使用 “never” 选项时,此规则的 错误 代码示例

在 Playground 中打开
/*eslint space-before-function-paren: ["error", "never"]*/

function foo () {
    // ...
}

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

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

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

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

var baz = async () => 1

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

在 Playground 中打开
/*eslint space-before-function-paren: ["error", "never"]*/

function foo() {
    // ...
}

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

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

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

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

var baz = async() => 1

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

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

在 Playground 中打开
/*eslint space-before-function-paren: ["error", {"anonymous": "always", "named": "never", "asyncArrow": "always"}]*/

function foo () {
    // ...
}

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

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

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

var baz = async(a) => await a

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

在 Playground 中打开
/*eslint space-before-function-paren: ["error", {"anonymous": "always", "named": "never", "asyncArrow": "always"}]*/

function foo() {
    // ...
}

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

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

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

var baz = async (a) => await a

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

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

在 Playground 中打开
/*eslint space-before-function-paren: ["error", { "anonymous": "never", "named": "always" }]*/

function foo() {
    // ...
}

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

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

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

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

在 Playground 中打开
/*eslint space-before-function-paren: ["error", { "anonymous": "never", "named": "always" }]*/

function foo () {
    // ...
}

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

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

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

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

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

在 Playground 中打开
/*eslint space-before-function-paren: ["error", { "anonymous": "ignore", "named": "always" }]*/

function foo() {
    // ...
}

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

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

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

在 Playground 中打开
/*eslint space-before-function-paren: ["error", { "anonymous": "ignore", "named": "always" }]*/

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

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

function foo () {
    // ...
}

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

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

何时不使用它

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

版本

此规则在 ESLint v0.18.0 中引入。

资源

更改语言