← Back to rules

vitest/prefer-describe-function-title スタイル

An auto-fix is available for this rule.

何をするか

特定の関数をテストする場合、このルールは describe() に同等のハードコードされた文字列ではなく、名前付き関数を渡すことを強制します。

なぜ問題なのか

特定の関数に関連するテストの場合、テスト対象の関数がリネームされると、describe のタイトルと一致しなくなり、将来混乱を招く可能性があります。関数名を使用することで、関数がリネームされても一貫性が保たれます。

例

このルールに対して不正なコードの例：

// myFunction.test.js
import { myFunction } from "./myFunction";

describe("myFunction", () => {
  // ...
});

このルールに対して正しいコードの例：

// myFunction.test.js
import { myFunction } from "./myFunction";

describe(myFunction, () => {
  // ...
});

使い方

このルールを設定ファイルまたは CLI で有効化するには、以下の方法が利用できます：

設定 (.oxlintrc.json)

{
  "plugins": ["vitest"],
  "rules": {
    "vitest/prefer-describe-function-title": "error"
  }
}

CLI

oxlint --deny vitest/prefer-describe-function-title --vitest-plugin

参照

• ルールのソース