feat: add alias option (#1634)

* chore: fix typeof check in error * feat: add alias option * Update test/core/vitest.config.ts
vitest-dev · Jul 19, 2022 · 7c2138f · 7c2138f
1 parent d507334
commit 7c2138f
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 3 deletions.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -109,6 +109,12 @@ This might potentially cause some misalignment if a package has different logic
 
 Interpret CJS module's default as named exports.
 
+### alias
+
+- **Type:** `Record<string, string> | Array<{ find: string | RegExp, replacement: string, customResolver?: ResolverFunction | ResolverObject }>`
+
+Define custom aliases when running inside tests. They will be merged with aliases from `resolve.alias`.
+
 ### globals
 
 - **Type:** `boolean`

diff --git a/packages/vite-node/src/externalize.ts b/packages/vite-node/src/externalize.ts
@@ -8,7 +8,7 @@ const ESM_FOLDER_RE = /\/(es|esm)\/(.*\.js)$/
 
 const defaultInline = [
   /virtual:/,
-  /\.ts$/,
+  /\.[mc]?ts$/,
 ]
 
 const depsExternal = [

diff --git a/packages/vitest/src/node/plugins/index.ts b/packages/vitest/src/node/plugins/index.ts
@@ -75,6 +75,7 @@ export async function VitestPlugin(options: UserConfig = {}, ctx = new Vitest())
             // by default Vite resolves `module` field, which not always a native ESM module
             // setting this option can bypass that and fallback to cjs version
             mainFields: [],
+            alias: preOptions.alias,
           },
           server: {
             ...preOptions.api,
@@ -101,6 +102,9 @@ export async function VitestPlugin(options: UserConfig = {}, ctx = new Vitest())
         if (viteConfigTest.watch === false)
           viteConfigTest.run = true
 
+        if ('alias' in viteConfigTest)
+          delete viteConfigTest.alias
+
         // viteConfig.test is final now, merge it for real
         options = deepMerge(
           {},

diff --git a/packages/vitest/src/runtime/error.ts b/packages/vitest/src/runtime/error.ts
@@ -81,7 +81,7 @@ export function processError(err: any) {
     if (typeof err.message === 'string')
       err.message = normalizeErrorMessage(err.message)
 
-    if (typeof err.cause === 'object' && err.cause.message === 'string')
+    if (typeof err.cause === 'object' && typeof err.cause.message === 'string')
       err.cause.message = normalizeErrorMessage(err.cause.message)
   }
   catch {}

diff --git a/packages/vitest/src/types/config.ts b/packages/vitest/src/types/config.ts
@@ -1,4 +1,4 @@
-import type { CommonServerOptions } from 'vite'
+import type { AliasOptions, CommonServerOptions } from 'vite'
 import type { PrettyFormatOptions } from 'pretty-format'
 import type { FakeTimerInstallOpts } from '@sinonjs/fake-timers'
 import type { BuiltinReporters } from '../node/reporters'
@@ -393,6 +393,13 @@ export interface InlineConfig {
      */
     seed?: number
   }
+
+  /**
+   * Specifies an `Object`, or an `Array` of `Object`,
+   * which defines aliases used to replace values in `import` or `require` statements.
+   * Will be merged with the default aliases inside `resolve.alias`.
+   */
+  alias?: AliasOptions
 }
 
 export interface UserConfig extends InlineConfig {

diff --git a/test/core/src/aliased-mod.ts b/test/core/src/aliased-mod.ts
@@ -0,0 +1 @@
+export const isAliased = true
diff --git a/test/core/test/alias.test.ts b/test/core/test/alias.test.ts
@@ -0,0 +1,7 @@
+// @ts-expect-error aliased to ../src/aliased-mod.ts
+import { isAliased } from 'test-alias'
+import { expect, test } from 'vitest'
+
+test('check that test.alias works', () => {
+  expect(isAliased).toBe(true)
+})
diff --git a/test/core/vitest.config.ts b/test/core/vitest.config.ts
@@ -56,5 +56,13 @@ export default defineConfig({
     sequence: {
       seed: 101,
     },
+    alias: [
+      {
+        find: 'test-alias',
+        replacement: '',
+        // vitest doesn't crash because function is defined
+        customResolver: () => resolve(__dirname, 'src', 'aliased-mod.ts'),
+      },
+    ],
   },
 })