Common Errors
Cannot find module './relative-path'
If you receive an error that module cannot be found, it might mean several different things:
- You misspelled the path. Make sure the path is correct.
- It's possible that you rely on
baseUrlin yourtsconfig.json. Vite doesn't take into accounttsconfig.jsonby default, so you might need to installvite-tsconfig-pathsyourself, if you rely on this behaviour.
- It's possible that you rely on
import { defineConfig } from 'vitest/config'
import tsconfigPaths from 'vite-tsconfig-paths'
export default defineConfig({
plugins: [tsconfigPaths()]
})Or rewrite your path to not be relative to root:
- import helpers from 'src/helpers'
+ import helpers from '../src/helpers'- Make sure you don't have relative aliases. Vite treats them as relative to the file where the import is instead of the root.
import { defineConfig } from 'vitest/config'
export default defineConfig({
test: {
alias: {
'@/': './src/',
'@/': new URL('./src/', import.meta.url).pathname,
}
}
})Failed to Terminate Worker
This error can happen when NodeJS's fetch is used with default pool: 'threads'. This issue is tracked on issue Timeout abort can leave process(es) running in the background #3077.
As work-around you can switch to pool: 'forks' or pool: 'vmForks'.
import { defineConfig } from 'vitest/config'
export default defineConfig({
test: {
pool: 'forks',
},
})vitest --pool=forksCustom package conditions are not resolved
If you are using custom conditions in your package.json exports or subpath imports, you may find that Vitest does not respect these conditions by default.
For example, if you have the following in your package.json:
{
"exports": {
".": {
"custom": "./lib/custom.js",
"import": "./lib/index.js"
}
},
"imports": {
"#internal": {
"custom": "./src/internal.js",
"default": "./lib/internal.js"
}
}
}By default, Vitest will only use the import and default conditions. To make Vitest respect custom conditions, you need to configure ssr.resolve.conditions in your Vitest config:
import { defineConfig } from 'vitest/config'
export default defineConfig({
ssr: {
resolve: {
conditions: ['custom', 'import', 'default'],
},
},
})Why ssr.resolve.conditions and not resolve.conditions?
Vitest follows Vite's configuration convention:
resolve.conditionsapplies to Vite'sclientenvironment, which corresponds to Vitest's browser mode, jsdom, happy-dom, or custom environments withviteEnvironment: 'client'.ssr.resolve.conditionsapplies to Vite'sssrenvironment, which corresponds to Vitest's node environment or custom environments withviteEnvironment: 'ssr'.
Since Vitest defaults to the node environment (which uses viteEnvironment: 'ssr'), module resolution uses ssr.resolve.conditions. This applies to both package exports and subpath imports.
You can learn more about Vite environments and Vitest environments in environment.
Segfaults and Native Code Errors
Running native NodeJS modules in pool: 'threads' can run into cryptic errors coming from the native code.
Segmentation fault (core dumped)thread '<unnamed>' panicked at 'assertion failedAbort trap: 6internal error: entered unreachable code
In these cases the native module is likely not built to be multi-thread safe. As work-around, you can switch to pool: 'forks' which runs the test cases in multiple node:child_process instead of multiple node:worker_threads.
import { defineConfig } from 'vitest/config'
export default defineConfig({
test: {
pool: 'forks',
},
})vitest --pool=forks