no-hooks.md

Disallow hooks (mocha/no-hooks)

🚫 This rule is disabled in the ✅ recommended config.

Mocha proposes hooks that allow code to be run before or after every or all tests. This helps define a common setup or teardown process for every test. The use of these hooks promotes the use of shared state between the tests, and defeats the purpose of having isolated unit tests.

Rule Details

This rule looks for every call to before, after, beforeEach and afterEach.

The following patterns are considered warnings:

describe('foo', function () {
    var mockUser;

    before(function () { // Not allowed
        mockUser = {age: 50};
    });

    after(function () { /* ... */ }); // Not allowed
    beforeEach(function () { /* ... */ }); // Not allowed
    afterEach(function () { /* ... */ }); // Not allowed

    it(function () {
        assert.equals(lib.method(mockUser), 'expectedValue');
    });
});

These patterns would not be considered warnings:

function createFixtures() {
    return {
        mockUser: {age: 50}
    };
}

describe('foo', function () {
    it(function () {
        var fixtures = createFixtures();
        assert.equals(lib.method(fixtures.mockUser), 'expectedValue');
    });
});

Options

This rule supports the following options:

• allow: An array containing the names of hooks to allow. Defaults to an empty array.

{
    "rules": {
        "mocha/no-hooks": ["error", {"allow": ["after"]}]
    }
}

When Not To Use It

• If you use another library which exposes a similar API as mocha (e.g. before, after), you should turn this rule off, because it would raise warnings.