Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion packages/cli/src/__tests__/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -254,12 +254,18 @@ test('defineConfig supports function config with plain plugins array', () => {
expect(userPlugins(config.plugins).length).toBe(1);
});

test('defineConfig supports async function config with plain plugins array', async () => {
test('defineConfig contextually types tool config in async functions', async () => {
const configFn = defineConfig(async () => ({
lint: {
rules: {
'no-console': 'warn',
},
},
plugins: [{ name: 'async-fn-plugin' }],
}));
const config = await configFn({ command: 'build', mode: 'production' });
expect(userPlugins(config.plugins).length).toBe(1);
expect(config.lint?.rules?.['no-console']).toBe('warn');
});

test('defineConfig supports vitest plugin with configureVitest hook', () => {
Expand Down
26 changes: 18 additions & 8 deletions packages/cli/src/define-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,16 @@ type ViteUserConfigExport =
| ViteUserConfigFnPromise
| ViteUserConfigFn;

type DefinedViteUserConfig<T extends ViteUserConfigExport> = T extends ViteUserConfigFnPromise
? ViteUserConfigFnPromise
: T extends ViteUserConfigFnObject
? ViteUserConfigFnObject
: T extends ViteUserConfigFn
? ViteUserConfigFn
: T extends Promise<UserConfig>
? Promise<UserConfig>
: UserConfig;

/**
* `require` anchored at THIS module's location so `require.resolve` reaches
* the `vitest` / `@vitest/*` family that the `vite-plus` package directly
Expand Down Expand Up @@ -864,14 +874,14 @@ function injectPluginIntoConfig(config: ViteUserConfigExport): ViteUserConfigExp
return injectPlugin(config);
}

export function defineConfig(config: UserConfig): UserConfig;
export function defineConfig(config: Promise<UserConfig>): Promise<UserConfig>;
export function defineConfig(config: ViteUserConfigFnObject): ViteUserConfigFnObject;
export function defineConfig(config: ViteUserConfigFnPromise): ViteUserConfigFnPromise;
export function defineConfig(config: ViteUserConfigExport): ViteUserConfigExport;

export function defineConfig(config: ViteUserConfigExport): ViteUserConfigExport {
return viteDefineConfig(injectPluginIntoConfig(config));
/**
* Keep a single generic signature so callback returns receive one contextual
* config type. Separate sync and async overloads make TypeScript widen nested
* literals in async callbacks before overload resolution (for example, an
* Oxlint rule severity of `'warn'` becomes `string`).
*/
export function defineConfig<T extends ViteUserConfigExport>(config: T): DefinedViteUserConfig<T> {
return viteDefineConfig(injectPluginIntoConfig(config)) as DefinedViteUserConfig<T>;
}

/**
Expand Down
Loading