← Back to rules

vitest/prefer-expect-assertions Style

💡 A suggestion is available for this rule.

What it does

Enforces that every test has either expect.assertions(<number>) or expect.hasAssertions() as its first expression.

Why is this bad?

Without explicit assertion counts, tests with asynchronous code, callbacks, or loops may pass even if some expect calls are never reached, silently hiding bugs.

Examples

Examples of incorrect code for this rule:

test("no assertions", () => {
  // ...
});
test("assertions not first", () => {
  expect(true).toBe(true);
  // ...
});

Examples of correct code for this rule:

test("with assertion count", () => {
  expect.assertions(1);
  expect(true).toBe(true);
});
test("with hasAssertions", () => {
  expect.hasAssertions();
  expect(true).toBe(true);
});

///Examples of incorrect code with { "onlyFunctionsWithAsyncKeyword": true }:

test("fetches data", async () => {
  const data = await fetchData();
  expect(data).toBe("peanut butter");
});

Examples of correct code with { "onlyFunctionsWithAsyncKeyword": true }:

test("fetches data", async () => {
  expect.assertions(1);
  const data = await fetchData();
  expect(data).toBe("peanut butter");
});

Examples of incorrect code with { "onlyFunctionsWithExpectInLoop": true }:

test("all numbers are greater than zero", () => {
  for (const number of getNumbers()) {
    expect(number).toBeGreaterThan(0);
  }
});

Examples of correct code with { "onlyFunctionsWithExpectInLoop": true }:

test("all numbers are greater than zero", () => {
  expect.hasAssertions();
  for (const number of getNumbers()) {
    expect(number).toBeGreaterThan(0);
  }
});

Examples of incorrect code with { "onlyFunctionsWithExpectInCallback": true }:

test("callback test", () => {
  fetchData((data) => {
    expect(data).toBe("peanut butter");
  });
});

Examples of correct code with { "onlyFunctionsWithExpectInCallback": true }:

test("callback test", () => {
  expect.assertions(1);
  fetchData((data) => {
    expect(data).toBe("peanut butter");
  });
});

Configuration

This rule accepts a configuration object with the following properties:

onlyFunctionsWithAsyncKeyword

type: boolean

default: false

onlyFunctionsWithExpectInCallback

type: boolean

default: false

onlyFunctionsWithExpectInLoop

type: boolean

default: false

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "plugins": ["vitest"],
  "rules": {
    "vitest/prefer-expect-assertions": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vitest"],
  rules: {
    "vitest/prefer-expect-assertions": "error",
  },
});

CLI

oxlint --deny vitest/prefer-expect-assertions --vitest-plugin

Version

This rule was added in v1.62.0.

References

• Rule Source
• Open rule in Oxc Playground