vitest/no-alias-methods

Some matchers have two names. For example, toBeCalled is the same matcher as toHaveBeenCalled. If a project uses both, a search for one name misses the tests that use the other.

--fix renames the matcher.

Configure#

Off by default. To turn it on:

bunfig.toml

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

Examples#

example.ts1 problem

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

test("saves the draft", () => {
  const save = vi.fn();
  save("draft");
  expect(save).toBeCalledWith("draft");
});

example.tsNo problems

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

test("saves the draft", () => {
  const save = vi.fn();
  save("draft");
  expect(save).toHaveBeenCalledWith("draft");
});

The full list:

Reported	Write instead
`toBeCalled`	`toHaveBeenCalled`
`toBeCalledTimes`	`toHaveBeenCalledTimes`
`toBeCalledWith`	`toHaveBeenCalledWith`
`lastCalledWith`	`toHaveBeenLastCalledWith`
`nthCalledWith`	`toHaveBeenNthCalledWith`
`toReturn`	`toHaveReturned`
`toReturnTimes`	`toHaveReturnedTimes`
`toReturnWith`	`toHaveReturnedWith`
`lastReturnedWith`	`toHaveLastReturnedWith`
`nthReturnedWith`	`toHaveNthReturnedWith`
`toThrowError`	`toThrow`