no-empty-function

禁止空函数

空函数会降低可读性，因为读者需要猜测它是否是故意的。所以为空函数写一个清晰的注释是一个好习惯。

function foo() {
    // do nothing.
}

特别是，箭头函数的空块可能会让开发人员感到困惑。它与空对象字面量非常相似。

list.map(() => {});   // This is a block, would return undefined.
list.map(() => ({})); // This is an empty object.

规则详情

该规则旨在消除空函数。如果函数包含注释，则不会将其视为问题。

此规则的错误代码示例：

/*eslint no-empty-function: "error"*/
/*eslint-env es6*/

function foo() {}

var foo = function() {};

var foo = () => {};

function* foo() {}

var foo = function*() {};

var obj = {
    foo: function() {},

    foo: function*() {},

    foo() {},

    *foo() {},

    get foo() {},

    set foo(value) {}
};

class A {
    constructor() {}

    foo() {}

    *foo() {}

    get foo() {}

    set foo(value) {}

    static foo() {}

    static *foo() {}

    static get foo() {}

    static set foo(value) {}
}

此规则的正确代码示例：

/*eslint no-empty-function: "error"*/
/*eslint-env es6*/

function foo() {
    // do nothing.
}

var foo = function() {
    // any clear comments.
};

var foo = () => {
    bar();
};

function* foo() {
    // do nothing.
}

var foo = function*() {
    // do nothing.
};

var obj = {
    foo: function() {
        // do nothing.
    },

    foo: function*() {
        // do nothing.
    },

    foo() {
        // do nothing.
    },

    *foo() {
        // do nothing.
    },

    get foo() {
        // do nothing.
    },

    set foo(value) {
        // do nothing.
    }
};

class A {
    constructor() {
        // do nothing.
    }

    foo() {
        // do nothing.
    }

    *foo() {
        // do nothing.
    }

    get foo() {
        // do nothing.
    }

    set foo(value) {
        // do nothing.
    }

    static foo() {
        // do nothing.
    }

    static *foo() {
        // do nothing.
    }

    static get foo() {
        // do nothing.
    }

    static set foo(value) {
        // do nothing.
    }
}

选项

此规则具有允许特定类型的函数为空的选项。

• allow (string[]) - 允许空函数的种类列表。列表项是以下一些字符串。默认为空数组 ([])。"functions" - 普通函数。 "arrowFunctions" - 箭头函数。 "generatorFunctions" - 生成器函数。 "methods" - 对象字面量的类方法和方法简写。 "generatorMethods" - 带有生成器的对象字面量的类方法和方法简写。 "getters" - 获取器。 "setters" - 设置器。 "constructors" - 类构造函数。 "asyncFunctions" - 异步函数。 "asyncMethods" - 对象字面量的异步类方法和方法简写。

allow: functions

{ "allow": ["functions"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["functions"] }]*/

function foo() {}

var foo = function() {};

var obj = {
    foo: function() {}
};

allow: arrowFunctions

{ "allow": ["arrowFunctions"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["arrowFunctions"] }]*/
/*eslint-env es6*/

var foo = () => {};

allow: generatorFunctions

{ "allow": ["generatorFunctions"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["generatorFunctions"] }]*/
/*eslint-env es6*/

function* foo() {}

var foo = function*() {};

var obj = {
    foo: function*() {}
};

allow: methods

{ "allow": ["methods"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["methods"] }]*/
/*eslint-env es6*/

var obj = {
    foo() {}
};

class A {
    foo() {}
    static foo() {}
}

allow: generatorMethods

{ "allow": ["generatorMethods"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["generatorMethods"] }]*/
/*eslint-env es6*/

var obj = {
    *foo() {}
};

class A {
    *foo() {}
    static *foo() {}
}

allow: getters

{ "allow": ["getters"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["getters"] }]*/
/*eslint-env es6*/

var obj = {
    get foo() {}
};

class A {
    get foo() {}
    static get foo() {}
}

allow: setters

{ "allow": ["setters"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["setters"] }]*/
/*eslint-env es6*/

var obj = {
    set foo(value) {}
};

class A {
    set foo(value) {}
    static set foo(value) {}
}

allow: constructors

{ "allow": ["constructors"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["constructors"] }]*/
/*eslint-env es6*/

class A {
    constructor() {}
}

allow: asyncFunctions

{ "allow": ["asyncFunctions"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["asyncFunctions"] }]*/
/*eslint-env es2017*/

async function a(){}

allow: asyncMethods

{ "allow": ["asyncMethods"] } 选项的正确代码示例：

/*eslint no-empty-function: ["error", { "allow": ["asyncMethods"] }]*/
/*eslint-env es2017*/

var obj = {
    async foo() {}
};

class A {
    async foo() {}
    static async foo() {}
}

何时不使用

如果您不想收到有关空函数的通知，那么禁用此规则是安全的。