jest/prefer-to-have-been-called Style

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

What it does

Suggests using toHaveBeenCalled() or not.toHaveBeenCalled() over toHaveBeenCalledTimes(0) or toBeCalledTimes(0).

Why is this bad?

toHaveBeenCalled() is more explicit and readable than toHaveBeenCalledTimes(0).

Examples

Examples of incorrect code for this rule:

expect(mock).toHaveBeenCalledTimes(0);
expect(mock).toBeCalledTimes(0);
expect(mock).not.toHaveBeenCalledTimes(0);

Examples of correct code for this rule:

expect(mock).not.toHaveBeenCalled();
expect(mock).toHaveBeenCalled();
expect(mock).toHaveBeenCalledTimes(1);

How to use

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

Config (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/prefer-to-have-been-called": "error"
  }
}

CLI

oxlint --deny jest/prefer-to-have-been-called --jest-plugin

References

• Rule Source