Skip to content

fix(types): improve defineConfig callback inference #21699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Vishnuuuu24 wants to merge 2 commits into from
+30 −4
Closed

fix(types): improve defineConfig callback inference #21699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c8aae6
fix(types): improve defineConfig callback inference
Vishnuuuu24 Feb 24, 2026
c8eceee
test(playground): preserve false literal in proxy bypass
Vishnuuuu24 Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions packages/vite/src/node/__tests_dts__/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,28 @@ defineConfig({
unknownProperty: 1,
})

defineConfig(() => ({
base: '',
build: {
minify: 'oxc',
},
}))

defineConfig(async () => ({
base: '',
build: {
minify: 'terser',
},
}))

// @ts-expect-error --- nested invalid option `build.unknown` should error
defineConfig(async () => ({
base: '',
build: {
unknown: 1,
},
}))

mergeConfig(defineConfig({}), defineConfig({}))
mergeConfig(
// @ts-expect-error
Expand Down
10 changes: 7 additions & 3 deletions packages/vite/src/node/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,15 @@ export type UserConfigExport =
* accepts a direct {@link UserConfig} object, or a function that returns it.
* The function receives a {@link ConfigEnv} object.
*/
export function defineConfig<T extends UserConfigFn>(
config: T & UserConfigFn,
): T extends UserConfigFnObject
? UserConfigFnObject
: T extends UserConfigFnPromise
? UserConfigFnPromise
: UserConfigFn
export function defineConfig(config: UserConfig): UserConfig
export function defineConfig(config: Promise<UserConfig>): Promise<UserConfig>
export function defineConfig(config: UserConfigFnObject): UserConfigFnObject
export function defineConfig(config: UserConfigFnPromise): UserConfigFnPromise
export function defineConfig(config: UserConfigFn): UserConfigFn
export function defineConfig(config: UserConfigExport): UserConfigExport
export function defineConfig(config: UserConfigExport): UserConfigExport {
return config
Expand Down
2 changes: 1 addition & 1 deletion playground/proxy-bypass/vite.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default defineConfig({
'/nonExistentApp': {
target: 'http://localhost:9607',
bypass: () => {
return false
return /** @type {false} */ (false)
},
},
'/proxyError': {
Expand Down