← Back to rules

jest/prefer-spy-on 风格

An auto-fix is available for this rule.

它的作用

当通过覆盖属性来模拟函数时，清理时必须手动恢复原始实现。而使用 jest.spyOn() 时，Jest 会跟踪这些更改，可以通过 jest.restoreAllMocks()、mockFn.mockRestore() 或在 Jest 配置中将 restoreMocks 设置为 true 来恢复。

注意：jest.spyOn() 创建的模拟仍然与原始函数行为一致。原始函数仍可通过 mockFn.mockImplementation() 或其他 模拟函数 进行覆盖。

为什么这是不好的？

直接用模拟函数覆盖属性可能导致清理问题和测试隔离问题。当你手动将模拟赋值给属性时，你负责恢复原始实现，这很容易被遗忘，可能导致测试之间相互干扰。使用 jest.spyOn() 可以提供自动清理功能，使你的测试更加可靠。

示例

此规则的 错误 代码示例：

Date.now = jest.fn();
Date.now = jest.fn(() => 10);

此规则的 正确 代码示例：

jest.spyOn(Date, "now");
jest.spyOn(Date, "now").mockImplementation(() => 10);

该规则与 eslint-plugin-vitest 兼容。要使用它，请在 .oxlintrc.json 中添加以下配置：

{
  "rules": {
    "vitest/prefer-spy-on": "error"
  }
}

如何使用

要通过配置文件或 CLI 启用 此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/prefer-spy-on": "error"
  }
}

CLI

oxlint --deny jest/prefer-spy-on --jest-plugin

参考资料

• 规则源码