deps
- 类型:
{ optimizer?, ... }
依赖解析的处理。
deps.optimizer
- 类型:
{ ssr?, client? } - 另见: 依赖优化选项
启用依赖优化。如果你有很多测试,这可能会提高它们的性能。
当 Vitest 遇到 include 中列出的外部库时,它将使用 esbuild 捆绑成单个文件并作为整个模块导入。这有几个好处:
- 导入具有大量导入的包开销很大。通过将它们捆绑到一个文件中,我们可以节省大量时间
- 导入 UI 库开销很大,因为它们不是为了在 Node.js 内部运行而设计的
- 你的
alias配置现在在捆绑包内生效 - 测试中的代码运行方式更接近其在浏览器中的运行方式
请注意,只有 deps.optimizer?.[mode].include 选项中的包会被捆绑(某些插件会自动填充此项,例如 Svelte)。你可以在 Vite 文档中阅读更多关于可用选项的信息(Vitest 不支持 disable 和 noDiscovery 选项)。默认情况下,Vitest 对 jsdom 和 happy-dom 环境使用 optimizer.client,对 node 和 edge 环境使用 optimizer.ssr。
此选项还会继承你的 optimizeDeps 配置(对于 web,Vitest 将扩展 optimizeDeps,对于 ssr - ssr.optimizeDeps)。如果你在 deps.optimizer 中重新定义 include/exclude 选项,它在运行测试时将扩展你的 optimizeDeps。如果 include 中列出的选项也在 exclude 中,Vitest 会自动将其从 include 中移除。
TIP
你将无法编辑 node_modules 中的代码进行调试,因为代码实际上位于 cacheDir 目录中。如果你想通过 console.log 语句进行调试,请直接编辑它或使用 deps.optimizer?.[mode].force 选项强制重新捆绑。
deps.optimizer.{mode}.enabled
- 类型:
boolean - 默认值:
false
启用依赖优化。
deps.client
- 类型:
{ transformAssets?, ... }
当环境设置为 client 时应用于外部文件的选项。默认情况下,jsdom 和 happy-dom 使用 client 环境,而 node 和 edge 环境使用 ssr,因此这些选项不会影响这些环境内的文件。
通常,node_modules 内部的文件会被外部化,但这些选项也会影响 server.deps.external 中的文件。
deps.client.transformAssets
- 类型:
boolean - 默认值:
true
Vitest 是否应该处理资产(.png, .svg, .jpg 等)文件并像 Vite 在浏览器中那样解析它们。
如果没有指定查询,此模块将拥有一个等于资产路径的默认导出。
deps.client.transformCss
- 类型:
boolean - 默认值:
true
Vitest 是否应该处理 CSS(.css, .scss, .sass 等)文件并像 Vite 在浏览器中那样解析它们。
如果 CSS 文件被 css 选项禁用,此选项将仅静默 ERR_UNKNOWN_FILE_EXTENSION 错误。
deps.client.transformGlobPattern
- 类型:
RegExp | RegExp[] - 默认值:
[]
用于匹配应转换的外部文件的正则表达式模式。
默认情况下,node_modules 内部的文件会被外部化且不转换,除非它是 CSS 或资产,且相应选项未被禁用。
deps.interopDefault
- 类型:
boolean - 默认值:
true
将 CJS 模块的 default 解释为命名导出。某些依赖项仅捆绑 CJS 模块,并且当使用 import 语法而不是 require 导入包时,不使用 Node.js 可以静态分析的命名导出。在 Node 环境中使用命名导出导入此类依赖项时,你将看到此错误:
import { read } from 'fs-jetpack';
^^^^
SyntaxError: Named export 'read' not found. The requested module 'fs-jetpack' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export.Vitest 不进行静态分析,并且无法在你的代码运行之前失败,因此如果禁用此功能,你在运行测试时最可能会看到此错误:
TypeError: createAsyncThunk is not a function
TypeError: default is not a function默认情况下,Vitest 假设你正在使用捆绑器来绕过此问题并且不会失败,但如果你的代码未经处理,你可以手动禁用此行为。
deps.moduleDirectories
- Type:
string[] - Default:
['node_modules']
包含依赖项的目录列表。Vitest 会在每个值前后加上斜杠,并检查文件路径是否包含该目录:'vendor' 会匹配 vendor 文件夹中的所有文件,绝对路径则只匹配该目录中的文件。Vitest 始终会包含 node_modules。
Vitest 会将这些目录中的文件视为依赖项:
- 未提供工厂函数的
vi.mock只会在项目根目录的__mocks__文件夹中查找模拟文件。 - Vitest 会外部化 Node.js 可直接导入的 JavaScript 文件,例如
type设置为module的包中的.js文件。Vitest 使用原生 Node.js 导入这些文件,Vite 插件不会转换它们,而vi.mock也不会作用于这些文件导入的模块。 - Vitest 会为
server.deps.inline和server.deps.external的字符串值添加这些目录作为前缀。
import { defineConfig } from 'vitest/config'
export default defineConfig({
test: {
deps: {
moduleDirectories: ['vendor'],
},
},
})TIP
在 monorepo 中模拟工作区包时,无需设置此选项。即使包解析到 node_modules 之外,只要你使用包名调用 vi.mock,Vitest 就会在根目录的 __mocks__ 文件夹中查找。
WARNING
不要添加包含项目源文件的目录。例如,若项目位于 packages/app,将 packages 设为此选项的值也会让 Vitest 把 packages/app 中的文件视为依赖项。