Skip to content
← Back to rules

vitest/prefer-to-be-object Style

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

作用

此规则强制使用 toBeObject() 来检查一个值是否为 Object 类型。

为什么这不好?

使用其他方法,例如 toBeInstanceOf(Object)instanceof Object,可能 不够清晰,并且容易产生误导。强制使用 toBeObject() 可以提供更明确、更易读的代码,使你的意图更加清楚, 并提升测试的整体可维护性和可读性。

示例

此规则的错误代码示例:

js
expectTypeOf({}).toBeInstanceOf(Object);
expectTypeOf({} instanceof Object).toBeTruthy();

此规则的正确代码示例:

js
expectTypeOf({}).toBeObject();
expectTypeOf({}).toBeObject();

如何使用

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

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

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

版本

此规则于 v0.9.2 中添加。

参考资料