Skip to content

typecheck 实验性

用于配置 类型检查 测试环境的选项。

typecheck.enabled

  • 类型: boolean
  • 默认值: false
  • 命令行终端: --typecheck, --typecheck.enabled

在常规测试的同时启用类型检查。

typecheck.only

  • 类型: boolean
  • 默认值: false
  • 命令行终端: --typecheck.only

仅运行类型检查测试,当类型检查启用时生效。在 CLI 中使用此选项会自动启用类型检查。

typecheck.checker

  • 类型: 'tsc' | 'vue-tsc' | string
  • 默认值: tsc

用于类型检查的工具。Vitest 将根据所选类型启动特定参数的进程以便解析,检查器需实现与 tsc 相同的输出格式。

使用类型检查器前需安装对应依赖包:

  • tsc 需要 typescript
  • vue-tsc 需要 vue-tsc

你也可以传入自定义二进制文件的路径或命令名称,该命令需能生成与 tsc --noEmit --pretty false 相同的输出格式。

typecheck.include

  • 类型: string[]
  • 默认值: ['**/*.{test,spec}-d.?(c|m)[jt]s?(x)']

匹配包含测试文件的 glob 规则。

typecheck.exclude

  • 类型: string[]
  • 默认值: ['**/node_modules/**', '**/dist/**', '**/cypress/**', '**/.{idea,git,cache,output,temp}/**']

匹配排除测试文件的 glob 规则。

typecheck.allowJs

  • 类型: boolean
  • 默认值: false

检查有 @ts-check 注释的 JS 文件。 如果你在 tsconfig 中启用它,则不会覆盖它。

typecheck.ignoreSourceErrors

  • 类型: boolean
  • 默认值: false

如果 Vitest 在测试文件之外发现错误,则不失败。这不会显示非测试文件的错误。

默认情况下,如果 Vitest 发现源码错误,会导致测试套件运行失败。

typecheck.tsconfig

  • 类型: string
  • 默认值: 尝试查找最近的 tsconfig.json

自定义 tsconfig 的路径,相对于项目根目录。

typecheck.spawnTimeout

  • 类型: number
  • 默认值: 10_000

启动类型检查器所需的最短时间(毫秒)。