← Back to rules

vitest/warn-todo 正确性

它的作用

当在 describe、it 或 test 函数中使用 .todo 时，此规则会触发警告。 建议将此规则与 CI 流水线结合使用，以标记拉取请求（PR）中的差异。

为什么这是个问题？

你提交的测试应该是完整的，任何未完成的“待办事项”代码都不应被提交。

示例

此规则的错误代码示例：

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

此规则的正确代码示例：

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

如何使用

要通过配置文件或 CLI 启用此规则，可以使用：

配置 (.oxlintrc.json)

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

CLI

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

参考资料

• 规则源码