← Back to rules

vitest/consistent-test-filename 风格

它做了什么

当一个文件被认为是测试文件，但其名称不符合预期的文件名格式时，此规则会触发错误。

为什么这是个问题？

测试文件若使用了不期望的文件名，会使区分源代码文件和测试文件变得困难。

示例

此规则配置为 {"allTestPattern": "__tests__", "pattern": ".*\.spec\.ts$"} 时的 错误 文件路径示例：

__tests__/2.ts

此规则配置为 {"allTestPattern": "__tests__", "pattern": ".*\.spec\.ts$"} 时的 正确 文件路径示例：

__tests__/2.spec.ts

配置

此规则接受一个包含以下属性的配置对象：

allTestPattern

type: string

确保仅对测试文件名进行校验的正则模式。 决定一个文件是否为测试文件。

pattern

type: string

用于检查测试文件名是否具有有效格式的必需正则表达式。 该模式没有默认值，您必须提供一个。

如何使用

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

配置 (.oxlintrc.json)

{
  "plugins": ["vitest"],
  "rules": {
    "vitest/consistent-test-filename": "error"
  }
}

CLI

oxlint --deny vitest/consistent-test-filename --vitest-plugin

参考资料

• 规则源码