Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.49 KB

no-setup-teardown.md

File metadata and controls

50 lines (32 loc) · 1.49 KB
Raw

Disallow setup/teardown module hooks (qunit/no-setup-teardown)

💼 This rule is enabled in the ✅ recommended config.

🔧 This rule is automatically fixable by the --fix CLI option.

QUnit supports two hooks at the module level: beforeEach and afterEach. These hooks are run before and after each test, respectively. Before QUnit 1.16.0, these hooks were known as setup and teardown, which sometimes caused ambiguity because it wasn't clear from the names whether these hooks would run before/after each test, or before any tests/after all tests.

QUnit 2.0 will remove support for setup and teardown hooks. This rule can be used to find module hooks with those names and rename them to beforeEach and afterEach.

Rule Details

The following patterns are considered warnings:

QUnit.module('A module', {
    setup: function () {},
    teardown: function () {}
});

The following patterns are not warnings:

QUnit.module('A module', {
    beforeEach: function () {},
    afterEach: function () {}
});

When Not To Use It

If you are working in a codebase that does not need to conform to QUnit 2.0 APIs, this rule can be safely disabled.

Further Reading