← Back to rules

vitest/prefer-to-contain Style

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

作用

为了获得更好的失败信息，在断言包含对象的数组时，应使用 toContain()。

为什么这不好？

当使用 toBe()、toEqual() 或 toStrictEqual() 来断言数组中包含对象时，此规则会触发警告。

示例

此规则的错误代码示例：

expect(a.includes(b)).toBe(true);
expect(a.includes(b)).not.toBe(true);
expect(a.includes(b)).toBe(false);
expect(a.includes(b)).toEqual(true);
expect(a.includes(b)).toStrictEqual(true);

此规则的正确代码示例：

expect(a).toContain(b);
expect(a).not.toContain(b);

如何使用

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

Config (.oxlintrc.json)

{
  "plugins": ["vitest"],
  "rules": {
    "vitest/prefer-to-contain": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vitest"],
  rules: {
    "vitest/prefer-to-contain": "error",
  },
});

CLI

oxlint --deny vitest/prefer-to-contain --vitest-plugin

版本

此规则是在 v0.2.14 中添加的。

参考资料

• Rule Source
• Open rule in Oxc Playground