← Back to rules

vitest/valid-describe-callback Correctness

What it does

This rule validates that the second parameter of a describe() function is a callback function. This callback function:

• should not contain any parameters
• should not contain any return statements

Vitest supports async describe() callbacks, so this rule allows them.

Why is this bad?

Using an improper describe() callback function can lead to unexpected test errors.

Examples

Examples of incorrect code for this rule:

// Callback function parameters are not allowed
describe("myFunction()", (done) => {
  // ...
});

// Returning a value from a describe block is not allowed
describe("myFunction", () =>
  it("returns a truthy value", () => {
    expect(myFunction()).toBeTruthy();
  }));

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/valid-describe-callback": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vitest"],
  rules: {
    "vitest/valid-describe-callback": "error",
  },
});

CLI

oxlint --deny vitest/valid-describe-callback --vitest-plugin

Version

This rule was added in v0.0.8.

References

• Rule Source
• Open rule in Oxc Playground