← Back to rules

jest/no-alias-methods 风格

An auto-fix is available for this rule.

它的作用

此规则确保代码中仅使用 Jest 文档中定义的规范名称。

为什么这是不好的？

这些别名将在 Jest 的下一个主要版本中被移除——详情请参见 jestjs/jest#13164。
此规则将使在代码中搜索方法的所有使用位置变得更加容易，并确保方法名称的一致性。

示例

此规则的 错误 代码示例：

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();

此规则的 正确 代码示例：

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();

此规则与 eslint-plugin-vitest 兼容。
要使用它，请将以下配置添加到你的 .oxlintrc.json 文件中：

{
  "rules": {
    "vitest/no-alias-methods": "error"
  }
}

使用 vitest 时，此规则的 错误 代码示例：

expect(a).toBeCalled();
expect(a).toBeCalledTimes();
expect(a).not["toThrowError"]();

使用 vitest 时，此规则的 正确 代码示例：

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();
expect(a).rejects;
expect(a);

如何使用

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

配置文件 (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/no-alias-methods": "error"
  }
}

CLI

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

参考资料

• 规则源码