fix(vitest): deprecate UserConfig in favor of ViteUserConfig (#6626)

vitest-dev · Oct 3, 2024 · 496bd25 · 496bd25
1 parent 970e0f4
commit 496bd25
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 8 deletions.
diff --git a/packages/vitest/src/public/config.ts b/packages/vitest/src/public/config.ts
@@ -15,7 +15,11 @@ export { mergeConfig } from 'vite'
 export { extraInlineDeps } from '../constants'
 export type { Plugin } from 'vite'
 
-export type { ConfigEnv, ViteUserConfig as UserConfig }
+export type { ConfigEnv, ViteUserConfig }
+/**
+ * @deprecated Use `ViteUserConfig` instead
+ */
+export type UserConfig = ViteUserConfig
 export type { UserProjectConfigExport, UserProjectConfigFn, UserWorkspaceConfig, WorkspaceProjectConfiguration }
 export type UserConfigFnObject = (env: ConfigEnv) => ViteUserConfig
 export type UserConfigFnPromise = (env: ConfigEnv) => Promise<ViteUserConfig>

diff --git a/test/config/test/bail.test.ts b/test/config/test/bail.test.ts
@@ -1,5 +1,6 @@
-import { type UserConfig, expect, test } from 'vitest'
+import { expect, test } from 'vitest'
 
+import type { UserConfig } from 'vitest/node'
 import { runVitest } from '../../test-utils'
 
 const configs: UserConfig[] = []

diff --git a/test/config/test/failures.test.ts b/test/config/test/failures.test.ts
@@ -1,5 +1,5 @@
 import { beforeEach, expect, test } from 'vitest'
-import type { UserConfig } from 'vitest'
+import type { UserConfig } from 'vitest/node'
 import { version } from 'vitest/package.json'
 
 import { normalize, resolve } from 'pathe'

diff --git a/test/config/test/mixed-environments.test.ts b/test/config/test/mixed-environments.test.ts
@@ -1,4 +1,5 @@
-import { type UserConfig, expect, test } from 'vitest'
+import { expect, test } from 'vitest'
+import type { UserConfig } from 'vitest/node'
 
 import { runVitest } from '../../test-utils'
 

diff --git a/test/config/test/override.test.ts b/test/config/test/override.test.ts
@@ -1,4 +1,4 @@
-import type { UserConfig } from 'vitest'
+import type { UserConfig } from 'vitest/node'
 import type { UserConfig as ViteUserConfig } from 'vite'
 import { describe, expect, it } from 'vitest'
 import { createVitest, parseCLI } from 'vitest/node'

diff --git a/test/config/test/shard.test.ts b/test/config/test/shard.test.ts
@@ -1,6 +1,7 @@
-import { type UserConfig, expect, test } from 'vitest'
+import { expect, test } from 'vitest'
 import { basename } from 'pathe'
 
+import type { UserConfig } from 'vitest/node'
 import * as testUtils from '../../test-utils'
 
 function runVitest(config: UserConfig) {

diff --git a/test/config/test/shuffle-options.test.ts b/test/config/test/shuffle-options.test.ts
@@ -1,4 +1,4 @@
-import type { InlineConfig } from 'vitest'
+import type { InlineConfig } from 'vitest/node'
 import { expect, test } from 'vitest'
 import { runVitest } from '../../test-utils'
 

diff --git a/test/config/test/workers-option.test.ts b/test/config/test/workers-option.test.ts
@@ -1,4 +1,5 @@
-import { type UserConfig, describe, expect, test, vi } from 'vitest'
+import { describe, expect, test, vi } from 'vitest'
+import type { UserConfig } from 'vitest/node'
 
 import { getWorkersCountByPercentage } from 'vitest/src/utils/workers.js'
 import * as testUtils from '../../test-utils'