← Back to rules

jest/valid-describe-callback 正しさ

何をするか

このルールは、describe() 関数の2番目のパラメータがコールバック関数であることを検証します。このコールバック関数は以下の条件を満たす必要があります：

• async として定義されてはいけない
• パラメータを含んではいけない
• return 文を含んではいけない

なぜ問題なのか

不適切な describe() コールバック関数を使用すると、予期しないテストエラーが発生する可能性があります。

例

このルールに違反する誤りのあるコードの例：

// 非同期コールバック関数は許可されません
describe("myFunction()", async () => {
  // ...
});

// コールバック関数にパラメータは許可されません
describe("myFunction()", (done) => {
  // ...
});

// describe ブロックから値を返すことは許可されません
describe("myFunction", () =>
  it("true な値を返す", () => {
    expect(myFunction()).toBeTruthy();
  }));

このルールは eslint-plugin-vitest と互換性があります。使用するには、.oxlintrc.json に次の設定を追加してください：

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

使い方

設定ファイルまたは CLI でこのルールを有効化するには、以下のようにします：

Config (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/valid-describe-callback": "error"
  }
}

CLI

oxlint --deny jest/valid-describe-callback --jest-plugin

参照

• ルールのソース