← Back to rules

vitest/prefer-to-be-truthy Style

💡 A suggestion is available for this rule.

What it does

This rule warns when toBe(true) is used with expect or expectTypeOf. With --fix-suggestions, it will be replaced with toBeTruthy().

Why is this bad?

When testing for truthiness, toBeTruthy() expresses that intent directly. Unlike toBe(true), it also accepts non-boolean truthy values such as non-empty strings and objects. The replacement is a suggestion because it changes which values pass the assertion.

Examples

Examples of incorrect code for this rule:

expect(foo).toBe(true);
expectTypeOf(foo).toBe(true);

Examples of correct code for this rule:

expect(foo).toBeTruthy();
expectTypeOf(foo).toBeTruthy();

How to use

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

Config (.oxlintrc.json)

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

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

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

CLI

oxlint --deny vitest/prefer-to-be-truthy --vitest-plugin

Version

This rule was added in v0.7.1.

References

• Rule Source
• Upstream rule docs
• Open rule in Oxc Playground