feat(plugin-api): support async configResolved hooks (fixes vitejs#2949)

dominikg · Apr 11, 2021 · 06e008e · 06e008e
1 parent 92b3193
commit 06e008e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/docs/guide/api-plugin.md b/docs/guide/api-plugin.md
@@ -189,8 +189,8 @@ Vite plugins can also provide hooks that serve Vite-specific purposes. These hoo
 
 ### `configResolved`
 
-- **Type:** `(config: ResolvedConfig) => void`
-- **Kind:** `sync`, `sequential`
+- **Type:** `(config: ResolvedConfig) => void | Promise<void>`
+- **Kind:** `async`, `sequential`
 
   Called after the Vite config is resolved. Use this hook to read and store the final resolved config. It is also useful when the plugin needs to do something different based the command is being run.
 

diff --git a/packages/vite/src/node/config.ts b/packages/vite/src/node/config.ts
@@ -376,11 +376,11 @@ export async function resolveConfig(
   )
 
   // call configResolved hooks
-  userPlugins.forEach((p) => {
+  for (const p of userPlugins) {
     if (p.configResolved) {
-      p.configResolved(resolved)
+      await p.configResolved(resolved)
     }
-  })
+  }
 
   if (process.env.DEBUG) {
     debug(`using resolved config: %O`, {

diff --git a/packages/vite/src/node/plugin.ts b/packages/vite/src/node/plugin.ts
@@ -68,7 +68,7 @@ export interface Plugin extends RollupPlugin {
   /**
    * Use this hook to read and store the final resolved vite config.
    */
-  configResolved?: (config: ResolvedConfig) => void
+  configResolved?: (config: ResolvedConfig) => void | Promise<void>
   /**
    * Configure the vite server. The hook receives the {@link ViteDevServer}
    * instance. This can also be used to store a reference to the server