NestJS 项目中 Vitest 测试环境配置的注意事项

在 NestJS 项目中配置 Vitest 测试环境时，开发者可能会遇到模块依赖解析失败的问题。本文将通过一个典型场景分析问题原因，并提供解决方案。

问题现象

当使用 Vitest 测试包含模块依赖的 NestJS 应用时，测试代码在尝试编译测试模块时会抛出依赖解析错误。典型错误信息显示 NestJS 无法解析某个模块的依赖项，即使这些依赖在运行时能够正常工作。

根本原因

Vitest 与 Jest 在模块解析机制上存在差异。Jest 通过 moduleNameMapper 配置自动处理 src/ 路径别名，而 Vitest 默认不具备这种自动解析能力。当测试代码中通过绝对路径引用模块时（如 src/b/b.module），Vitest 无法正确找到这些模块。

解决方案

需要在 Vitest 配置文件中显式设置路径别名解析规则。具体配置如下：

import { defineConfig } from 'vitest/config';
import swc from 'unplugin-swc';
import { resolve } from 'path';

export default defineConfig({
  test: {
    globals: true,
    root: './',
  },
  plugins: [swc.vite({ module: { type: 'es6' } })],
  resolve: {
    alias: {
      src: resolve(__dirname, './src'),
    },
  },
});

关键配置项说明：

1. resolve.alias 定义了路径别名映射规则
2. resolve(__dirname, './src') 将 src 别名指向项目根目录下的 src 目录
3. root: './' 确保测试运行时的基础路径正确

最佳实践

1. 对于新项目，建议在初始化时就配置好测试环境的路径解析
2. 从 Jest 迁移到 Vitest 时，需要特别注意路径解析配置的差异
3. 可以创建共享的 vitest 配置文件供多个测试文件复用
4. 考虑在项目中添加路径解析的单元测试，确保配置正确性

总结

Vitest 作为新兴的测试框架，在 NestJS 项目中需要特别注意模块解析的配置。通过合理配置路径别名，可以确保测试环境与运行时环境的一致性，避免因模块解析导致的测试失败问题。