← Back to rules

jest/require-to-throw-message Correctness

作用

如果在使用 toThrow() 或 toThrowError() 时没有提供错误消息，此规则会触发警告。

为什么这不好？

在未指定预期错误消息的情况下使用 toThrow() 或 toThrowError() 会让测试不够具体，也更难调试。当测试只检查是否抛出了 错误，而不检查是什么类型的错误时，即使抛出了错误的 异常，测试也可能通过，从而潜在地掩盖 bug。提供预期的错误消息 或错误类型可以让测试更精确，并更有效地发现回归问题。

示例

此规则的错误代码示例如下：

test("all the things", async () => {
  expect(() => a()).toThrow();
  expect(() => a()).toThrowError();
  await expect(a()).rejects.toThrow();
  await expect(a()).rejects.toThrowError();
});

此规则的正确代码示例如下：

test("all the things", async () => {
  expect(() => a()).toThrow("a");
  expect(() => a()).toThrowError("a");
  await expect(a()).rejects.toThrow("a");
  await expect(a()).rejects.toThrowError("a");
});

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/require-to-throw-message": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jest"],
  rules: {
    "jest/require-to-throw-message": "error",
  },
});

CLI

oxlint --deny jest/require-to-throw-message --jest-plugin

版本

此规则于 v0.2.9 中加入。

参考

• Rule Source
• Open rule in Oxc Playground