Vue.js Jest 转换器 `vue-jest` 教程

1. 项目介绍

Vue.js Jest 转换器 vue-jest 是一个专为 Vue 单文件组件（Single File Components）设计的 Jest 预处理器。它允许你在 Jest 测试环境中顺利地编译和运行 Vue 组件，支持 <script>, <template> 和 <style> 标签的不同语言版本，包括 TypeScript, CoffeeScript 等。此外，vue-jest 还可以处理自定义块。

2. 项目快速启动

安装

根据你的 Vue 版本和 Jest 版本，选择相应的 vue-jest 包：

对于 Vue 2 和 Jest 26 及以下版本：

npm install --save-dev @vue/vue2-jest@28
# 或者使用 Yarn
yarn add @vue/vue2-jest@28 --dev

对于 Vue 3 和 Jest 26 至 28 版本：

npm install --save-dev @vue/vue3-jest@28
# 或者使用 Yarn
yarn add @vue/vue3-jest@28 --dev

配置

在 jest.config.js 文件中添加配置，映射 Vue 文件到 vue-jest 转换器：

module.exports = {
  transform: {
    '^.+\\.vue$': '@vue/vue2-jest' // 根据你的安装版本更新这里
  },
  moduleFileExtensions: ['js', 'json', 'vue'],
}

如果你使用了 Babel，确保也包含了对 .js 文件的转换：

transform: {
  '^+.+\\.js$': 'babel-jest',
  '^+.+\\.vue$': '@vue/vue2-jest'
},

编写测试

现在你可以创建 Jest 测试文件，并像正常那样引入并测试你的 Vue 组件了。

3. 应用案例和最佳实践

• 使用全局 Jest 选项：可以通过 globals 对象在 Jest 的配置中改变 vue-jest 的行为，例如禁用默认的 refTransform。

module.exports = {
  // ...
  globals: {
    'vue-jest': {
      compilerOptions: {
        refTransform: false,
      }
    }
  }
};

• 处理自定义块：如果你的 Vue 文件中包含自定义块，如图表或特殊的样式库，记得在 Vue 编译器中注册这些扩展以便 vue-jest 可以识别和处理它们。

• 集成其他预处理器：例如，如果你的 <script> 标签使用 TypeScript，确保已经正确设置了 Babel 配置以支持 TypeScript。

4. 典型生态项目

vue-jest 广泛应用于 Vue.js 社区的各种项目，包括但不限于：

• 使用 Vue CLI 的项目，因为它内置了 Jest 集成。
• 在 Vue.js 库或应用中进行单元测试和端到端测试。
• 结合 Vuex 和 Vue Router 进行复杂应用程序的测试。

参考项目：

• Vuetify - 基于 Vue.js 的 Material Design UI 框架。
• Nuxt.js - 基于 Vue.js 的通用应用程序框架，支持服务端渲染。

通过遵循这些指南，你应该能够轻松地在你的 Vue 项目中集成和使用 vue-jest 进行测试。祝你好运，愉快地测试你的代码！