← Back to rules

vitest/warn-todo 正しさ

何を実行するか

このルールは、describe、it、または test 関数内で .todo が使用された場合に警告を発します。 このルールを CI パイプラインと併用することで、プルリクエストの差分に注記を付けることが推奨されます。

なぜ悪いのか

プッシュするテストは完了しているべきです。保留中の「TODO」コードはコミットしてはいけません。

例

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

describe.todo("foo", () => {});
it.todo("foo", () => {});
test.todo("foo", () => {});

このルールに対して 適切な コードの例：

describe([])("foo", () => {});
it([])("foo", () => {});
test([])("foo", () => {});

使い方

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

Config (.oxlintrc.json)

{
  "plugins": ["vitest"],
  "rules": {
    "vitest/warn-todo": "error"
  }
}

CLI

oxlint --deny vitest/warn-todo --vitest-plugin

参照

• ルールのソース