jest/valid-describe-callback 正确性

它的作用是什么

此规则验证 describe() 函数的第二个参数是一个回调函数。此回调函数

• 不应该 async
• 不应该包含任何参数
• 不应该包含任何 return 语句

为什么这样不好？

使用不当的 describe() 回调函数会导致意外的测试错误。

示例

// Async callback functions are not allowed
describe("myFunction()", async () => {
  // ...
});

// Callback function parameters are not allowed
describe("myFunction()", (done) => {
  // ...
});

// Returning a value from a describe block is not allowed
describe("myFunction", () =>
  it("returns a truthy value", () => {
    expect(myFunction()).toBeTruthy();
  }));

此规则与 eslint-plugin-vitest 兼容，要使用它，请将以下配置添加到您的 .eslintrc.json

{
  "rules": {
    "vitest/valid-describe-callback": "error"
  }
}

参考资料

• 规则源