Skip to content
← Back to rules

vitest/prefer-called-once Style

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

它的作用

toBeCalledTimes(1)toHaveBeenCalledTimes(1) 分别替换为 toBeCalledOnce()toHaveBeenCalledOnce()

为什么这不好?

*Times 匹配器需要读取参数,才能知道一个 spy 预期会被调用多少次。 大多数情况下,你期望一个方法只被调用一次。

示例

以下是此规则的错误代码示例:

js
test("foo", () => {
  const mock = vi.fn();
  mock("foo");
  expect(mock).toBeCalledTimes(1);
  expect(mock).toHaveBeenCalledTimes(1);
});

以下是此规则的正确代码示例:

js
test("foo", () => {
  const mock = vi.fn();
  mock("foo");
  expect(mock).toBeCalledOnce();
  expect(mock).toHaveBeenCalledOnce();
});

如何使用

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

json
{
  "plugins": ["vitest"],
  "rules": {
    "vitest/prefer-called-once": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vitest"],
  rules: {
    "vitest/prefer-called-once": "error",
  },
});
bash
oxlint --deny vitest/prefer-called-once --vitest-plugin

版本

此规则在 v1.39.0 中添加。

参考资料