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"
選項時,不正確的程式碼範例:
/*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 = asynca) => 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 中引入。