Skip to content
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

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

Merged
merged 3 commits into from
Apr 13, 2021
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3196616
feat(plugin-api): support async configResolved hooks (fixes #2949)
dominikg Apr 11, 2021
fac226c
feat(plugin-api): parallel execution of async configResolved
dominikg Apr 12, 2021
8de244a
chore: use optional chaining
dominikg Apr 13, 2021
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
4 changes: 2 additions & 2 deletions docs/guide/api-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`, `parallel`

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.

Expand Down
8 changes: 3 additions & 5 deletions packages/vite/src/node/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,11 +376,9 @@ export async function resolveConfig(
)

// call configResolved hooks
userPlugins.forEach((p) => {
if (p.configResolved) {
p.configResolved(resolved)
}
})
await Promise.all(
userPlugins.map((p) => p.configResolved && p.configResolved(resolved))
Shinigami92 marked this conversation as resolved.
Show resolved Hide resolved
)

if (process.env.DEBUG) {
debug(`using resolved config: %O`, {
Expand Down
2 changes: 1 addition & 1 deletion packages/vite/src/node/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down