Skip to content

Commit

Permalink
docs: add a warning about aliasing (vitest-dev#5618)
Browse files Browse the repository at this point in the history
  • Loading branch information
sheremet-va committed Apr 25, 2024
1 parent 81f57f4 commit d7fa5cd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,14 @@ To provide object via CLI command, use the following syntax: `--outputFile.json=

Define custom aliases when running inside tests. They will be merged with aliases from `resolve.alias`.

::: warning
Vitest uses Vite SSR primitives to run tests which has [certain pitfalls](https://vitejs.dev/guide/ssr.html#ssr-externals).

1. Aliases affect only modules imported directly with an `import` keyword by an [inlined](#server-deps-inline) module (all source code is inlined by default).
2. Vitest does not support aliasing `require` calls.
3. If you are aliasing an external dependency (e.g., `react` -> `preact`), you may want to alias the actual `node_modules` packages instead to make it work for externalized dependencies. Both [Yarn](https://classic.yarnpkg.com/en/docs/cli/add/#toc-yarn-add-alias) and [pnpm](https://pnpm.io/aliases/) support aliasing via the `npm:` prefix.
:::

### globals

- **Type:** `boolean`
Expand Down

0 comments on commit d7fa5cd

Please sign in to comment.