vitest/no-hooks

A hook usually sets a variable that every test in the block shares. To understand one test you have to find the hooks above it, and a test that changes the shared value can break the next one. A test that calls a setup function itself shows everything it depends on.

Configure#

Off by default. To turn it on:

[lint.rules]
"vitest/no-hooks" = "error" # or "warn"

Every option, set to its default:

[lint.rules]
"vitest/no-hooks" = ["error", {
  allow = [], # list of strings
}]

Examples#

import { beforeEach, expect, test } from "vitest";

let cart;

beforeEach(() => {
  cart = createCart();
});

test("starts empty", () => {
  expect(cart.items).toEqual([]);
});

import { expect, test } from "vitest";

test("starts empty", () => {
  const cart = createCart();
  expect(cart.items).toEqual([]);
});

Options#

With { "allow": ["afterEach"] }, only beforeAll is reported here:

import { afterEach, beforeAll, vi } from "vitest";

afterEach(() => {
  vi.restoreAllMocks();
});

beforeAll(() => {
  server.listen();
});

When not to use it#

Hooks are the usual way to start something slow once per file, such as a server or a database, and to stop it afterwards. If your tests do that, allow those hooks or leave the rule off.