Add support for async configs

defineConfig now accepts a promise for a config or function that returns one - fixes drizzle-team#1982

drizzle-kit/src/cli/commands/utils.ts

@@ -845,7 +845,7 @@ export const drizzleConfigFromFile = async (
 	unregister();
 
 	// --- get response and then check by each dialect independently
-	const res = configCommonSchema.safeParse(content);
+	const res = configCommonSchema.safeParse(await content);
 	if (!res.success) {
 		console.log(res.error);
 		if (!('dialect' in content)) {

drizzle-kit/src/index.ts

@@ -321,6 +321,6 @@ export type Config =
  *
  * See https://orm.drizzle.team/kit-docs/config-reference#strict
  */
-export function defineConfig(config: Config) {
-	return config;
+export function defineConfig(config: Config | Promise<Config> | (() => Config | Promise<Config>)) {
+	return typeof config === 'function' ? config() : config;
 }

drizzle-kit/tests/cli-async-config.test.ts

@@ -0,0 +1,14 @@
+import { test as brotest } from '@drizzle-team/brocli';
+import { assert, expect, test } from 'vitest';
+import { exportRaw } from '../src/cli/schema';
+
+test('export with async config', async (t) => {
+	const res = await brotest(exportRaw, '');
+
+	if (res.type !== 'handler') assert.fail(res.type, 'handler');
+	expect(res.options).toStrictEqual({
+		dialect: 'postgresql',
+		schema: './schema.ts',
+		sql: true,
+	});
+});

drizzle-kit/tests/cli/async.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from '../../src';
+
+export default defineConfig(async () => ({
+	schema: './schema.ts',
+	dialect: 'postgresql',
+	dbCredentials: {
+		url: 'postgresql://postgres:[email protected]:5432/db',
+	},
+}));