Skip to content
← Back to rules

vitest/consistent-vitest-vi Style

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

它的作用

当使用了意外的 vitest 访问器时,此规则会触发错误。

为什么这不好?

如果 vivitest 交替使用,未保持一致的 vitest 访问器会导致混淆。

示例

此规则的错误代码示例:

js
vitest.mock("./src/calculator.ts", { spy: true });

vi.stubEnv("NODE_ENV", "production");

此规则的正确代码示例:

js
vi.mock("./src/calculator.ts", { spy: true });

vi.stubEnv("NODE_ENV", "production");

配置

此规则接受一个具有以下属性的配置对象:

fn

type: "vi" | "vitest"

default: "vi"

决定是否优先使用 vitest 函数访问器

如何使用

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

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

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

版本

此规则于 v1.37.0 中添加。

参考资料