← Back to rules

jest/prefer-todo スタイル

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

何をするか

テストケースが空の場合、結果の要約出力で強調表示されるように、test.todo としてマークしたほうが良いです。

なぜ問題なのか

このルールは、test.todo を使わずに空のテストケースを使用した場合に警告を発します。

例

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

test("このテストを書く必要がある"); // 不正
test("このテストを書く必要がある", () => {}); // 不正
test.skip("このテストを書く必要がある", () => {}); // 不正

このルールに準拠するコードの例：

test.todo("このテストを書く必要がある");

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

{
  "rules": {
    "vitest/prefer-todo": "error"
  }
}

使い方

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

Config (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/prefer-todo": "error"
  }
}

CLI

oxlint --deny jest/prefer-todo --jest-plugin

参考資料

• ルールのソース