no-async-describe

Rules details#

This rule disallows the use of an async function with describe. It usually indicates a copy/paste error or that you’re trying to use describe for setup code, which should happen in before or beforeEach. Also, it can lead to the contained it blocks not being picked up.

Incorrect#

describe('the thing', async function () {
    // This work should happen in a beforeEach:
    const theThing = await getTheThing();

    it('should foo', function () {
        // ...
    });
});

describe('something', async function () {
    it('should work', function () {});
});

describe('something', async () => {
    it('should work', function () {});
});

async function mySuite() {
    it('my test', () => {});
}

describe('my suite', mySuite);

When Not To Use It#

• If you use another library which exposes a similar API as mocha, you should turn this rule off because it would raise warnings.
• In environments that have not yet adopted ES6 language features (ES3/5).