1. 模块定位

Snapshot 模块实现了 Jest 兼容的快照测试功能。它负责快照文件的存储、读取、比对和更新。同时支持传统的文件快照(__snapshots__/*.snap)和内联快照(快照值直接写入源码)。

2. SnapshotManager

SnapshotManager 是快照系统的核心管理类。它维护一个 SnapshotSummary 对象来跟踪全局快照状态:

  • added — 新增快照数
  • updated — 更新快照数
  • matched — 匹配成功数
  • unmatched — 不匹配数
  • filesAdded / filesUpdated / filesRemoved — 文件级变更统计
packages/snapshot/src/manager.ts:8-42IDE 打开
export class SnapshotManager {
  summary!: SnapshotSummary
  extension = '.snap'
  constructor(options) { this.clear() }
  clear() { this.summary = emptySummary(this.options) }
  add(result) { addSnapshotResult(this.summary, result) }

  // ★ 快照路径解析策略
  resolvePath(testPath, context?) {
    return join(dirname(testPath), '__snapshots__', basename(testPath) + '.snap')
  }
}

3. 内联快照

内联快照(Inline Snapshot)是 Vitest 的独特能力——快照值直接存在测试源码中,由 --update 标志自动更新源码文件:

expect({ name: 'Alice' }).toMatchInlineSnapshot(`
  {
    "name": "Alice",
  }
`)

实现位于 packages/snapshot/src/port/inlineSnapshot.ts,它使用 MagicString 进行源码修改——精确定位 toMatchInlineSnapshot() 调用的 AST 节点,替换其中的快照字面量。

4. 快照序列化

packages/snapshot/src/port/rawSnapshot.ts 负责将快照对象序列化为 .snap 文件格式。它使用 @vitest/pretty-format 进行格式化输出(类 Jest 的 pretty-format),并提供序列化器(Serializer)机制支持自定义对象的格式转换。

快照环境接口(SnapshotEnvironment)定义了跨平台的文件操作抽象:

  • readSnapshotFile(path) — 读取快照文件
  • saveSnapshotFile(path, content) — 写入快照文件
  • resolvePath(path) — 路径解析

5. 学习要点

🏗️ 学习主题关键收获
快照存储策略默认路径 __snapshots__/testFile.snap + 可自定义解析器
内联快照MagicString AST 改写——源码中嵌入快照值
环境抽象SnapshotEnvironment 接口——解耦文件系统依赖
序列化器pretty-format + 自定义插件——可扩展的值格式化