版本

space-before-function-paren

强制函数定义开始括号前的一致空格

🔧 可修复

此规则报告的一些问题可以通过 --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" 选项时,此规则的错误代码示例

在游乐场中打开
/*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" 选项时,此规则的正确代码示例

在游乐场中打开
/*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" 选项时,此规则的错误代码示例

在游乐场中打开
/*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" 选项时,此规则的正确代码示例

在游乐场中打开
/*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"} 选项时,此规则的错误代码示例

在游乐场中打开
/*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"} 选项时,此规则的正确代码示例

在游乐场中打开
/*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"} 选项时,此规则的错误代码示例

在游乐场中打开
/*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"} 选项时,此规则的正确代码示例

在游乐场中打开
/*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"} 选项时,此规则的错误代码示例

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

function foo() {
    // ...
}

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

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

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

在游乐场中打开
/*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 中引入。

资源

更改语言