类型测试

Sample Project

GitHub - Play Online

Vitest 允许你使用 expectTypeOf 或 assertType 语法为你的类型编写测试。默认情况下，*.test-d.ts 文件中的所有测试都被视为类型测试，但你可以使用 typecheck.include 配置选项更改它。

在这里，Vitest 调用 tsc 或 vue-tsc，具体取决于你的配置，并解析结果。如果发现任何类型错误，Vitest 还会在你的源代码中打印出类型错误。你可以使用 typecheck.ignoreSourceErrors 配置选项禁用它。

请记住，Vitest 不运行或编译这些文件，它们仅由编译器静态分析，因此你不能使用任何动态语句。这意味着，你不能使用动态测试名称和 test.each、test.runIf、test.skipIf、test.each、test.concurrent API。但是你可以使用其他 API，例如 test、describe、.only、.skip 和 .todo。

使用 CLI 标志，如 --allowOnly 和 -t 也支持类型检查。

import { assertType, expectTypeOf } from 'vitest'
import { mount } from './mount.js'

test('my types work properly', () => {
  expectTypeOf(mount).toBeFunction()
  expectTypeOf(mount).parameter(0).toMatchTypeOf<{ name: string }>()

  // @ts-expect-error name is a string
  assertType(mount({ name: 42 }))
})

在测试文件中触发的任何类型错误都将被视为测试错误，因此你可以使用任何类型技巧来测试项目中的类型。

你可以在 API 部分 中查看可能的匹配器列表。

读取错误

如果使用的是 expectTypeOf API，请参阅 expect-type 关于其错误信息的文档。

当类型不匹配时，.toEqualTypeOf 和 .toMatchTypeOf会使用一种特殊的辅助类型来生成尽可能可操作的错误信息。但要理解它们还有一些细微差别。由于断言是 "流畅地 "编写的，所以失败应该发生在 "预期 "类型上，而不是 "实际 "类型上（expect<Actual>().toEqualTypeOf<Expected>()）。这意味着类型错误可能有点令人困惑，因此该库生成了一个 MismatchInfo 类型，试图明确说明期望是什么。例如

expectTypeOf({ a: 1 }).toEqualTypeOf<{ a: string }>()

是一个将失败的断言，因为 {a: 1} 的类型是 {a: number} 而不是 {a: string}。 这种情况下的错误信息如下

test/test.ts:999:999 - error TS2344: Type '{ a: string; }' does not satisfy the constraint '{ a: \\"Expected: string, Actual: number\\"; }'.
  Types of property 'a' are incompatible.
    Type 'string' is not assignable to type '\\"Expected: string, Actual: number\\"'.

999 expectTypeOf({a: 1}).toEqualTypeOf<{a: string}>()

请注意，报告的类型约束是一个可读性强的消息，指定了"期望"和"实际"类型。不要字面上解读句子 Types of property 'a' are incompatible // Type 'string' is not assignable to type "Expected: string, Actual: number" ，而是看属性名（'a'）和消息内容：Expected: string, Actual: number。这将告诉你出了什么问题，在大多数情况下。当然，对于非常复杂的类型，调试可能需要更多的努力，并且可能需要一些试验。如果错误消息实际上是误导性的，请提出问题。

对于像 expectTypeOf(1).toBeString() 这样的断言，toBe... 方法（如 toBeString、toBeNumber、toBeVoid 等）在被测试的 Actual 类型不匹配时会解析为一个不可调用的类型。例如，失败的断言可能会显示如下内容：

test/test.ts:999:999 - error TS2349: This expression is not callable.
  Type 'ExpectString<number>' has no call signatures.

999 expectTypeOf(1).toBeString()
                    ~~~~~~~~~~

这部分的This expression is not callable并没有太大的帮助 - 有意义的错误在下一行，Type 'ExpectString<number> has no call signatures。这基本上意味着你传递了一个数字，但断言它应该是一个字符串。

如果 TypeScript 添加了对 "throw" 类型 的支持，这些错误消息将会显著改进。在那之前，它们需要一定程度的仔细观察。

具体的 "expected " 对象与类型参数

像这样的断言的错误消息：

expectTypeOf({ a: 1 }).toEqualTypeOf({ a: '' })

对于像这样的断言，错误消息将不够有帮助：

expectTypeOf({ a: 1 }).toEqualTypeOf<{ a: string }>()

这是因为 TypeScript 编译器需要推断 .toEqualTypeOf({a: ''}) 样式的类型参数，并且该库只能通过将其与通用的 Mismatch 类型进行比较来标记它为失败。因此，在可能的情况下，使用类型参数而不是具体类型来使用 .toEqualTypeOf 和 toMatchTypeOf。如果使用两个具体类型进行比较更加方便，可以使用 typeof：

const one = valueFromFunctionOne({ some: { complex: inputs } })
const two = valueFromFunctionTwo({ some: { other: inputs } })

expectTypeOf(one).toEqualTypeof<typeof two>()

如果你发现很难使用 expectTypeOf API 并找出错误，你始终可以使用更简单的 assertType API：

const answer = 42

assertType<number>(answer)
// @ts-expect-error answer is not a string
assertType<string>(answer)

TIP

使用 @ts-expect-error 语法时，你可能想确保没有输入错误。你可以通过在 test.include 配置选项中包含你的类型文件来做到这一点，因此 Vitest 实际上也会运行这些测试并因 ReferenceError 而失败。

这将通过，因为它预计会出现错误，但 “answer” 这个词有错别字，所以这是一个误报错误：

// @ts-expect-error answer is not a string
assertType<string>(answr) //

运行类型检查

从 Vitest 1.0 开始要启用类型检查，只需在 package.json 文件中的 Vitest 命令中添加 --typecheck 标志：

{
  "scripts": {
    "test": "vitest --typecheck"
  }
}

现在你可以运行 typecheck:

npm

npm run test

yarn

yarn test

pnpm

pnpm run test

bun

bun test

Vitest 使用 tsc --noEmit 或 vue-tsc --noEmit，具体取决于你的配置，因此可以从管道中删除这些脚本。