← Back to rules

vitest/no-alias-methods Style

🛠️ An auto-fix is available for this rule.

What it does

Enforces Vitest's canonical matcher names instead of aliases.

Why is this bad?

Vitest matcher aliases are discouraged because they make matcher usage inconsistent. This rule makes it easier to search for all occurrences of a matcher and ensures consistency among matcher names.

Examples

Examples of incorrect code for this rule:

expect(a).toBeCalled();
expect(a).toBeCalledTimes();
expect(a).toBeCalledWith();
expect(a).lastCalledWith();
expect(a).nthCalledWith();
expect(a).toReturn();
expect(a).toReturnTimes();
expect(a).toReturnWith();
expect(a).lastReturnedWith();
expect(a).nthReturnedWith();
expect(a).toThrowError();

Examples of correct code for this rule:

expect(a).toHaveBeenCalled();
expect(a).toHaveBeenCalledTimes();
expect(a).toHaveBeenCalledWith();
expect(a).toHaveBeenLastCalledWith();
expect(a).toHaveBeenNthCalledWith();
expect(a).toHaveReturned();
expect(a).toHaveReturnedTimes();
expect(a).toHaveReturnedWith();
expect(a).toHaveLastReturnedWith();
expect(a).toHaveNthReturnedWith();
expect(a).toThrow();

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/no-alias-methods": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vitest"],
  rules: {
    "vitest/no-alias-methods": "error",
  },
});

CLI

oxlint --deny vitest/no-alias-methods --vitest-plugin

Version

This rule was added in v0.0.12.

References

• Rule Source
• Open rule in Oxc Playground