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

Jump to bottom

feat(nuxi): reload nuxt when restart hook is called #19084

Merged
merged 7 commits into from
Mar 1, 2023
Merged

feat(nuxi): reload nuxt when restart hook is called #19084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9af7bef
feat-#18678: add restart hook
Baroshem Feb 16, 2023
ca8f244
feat-#18678: restart hook docs
Baroshem Feb 16, 2023
240615a
Update packages/nuxi/src/commands/dev.ts
Baroshem Feb 16, 2023
9fedcaa
fix: access `hookOnce` from `nuxtApp.hooks`
danielroe Feb 16, 2023
00757fa
docs: slight wording tweak
danielroe Feb 16, 2023
951c321
docs: add note that this feature is not yet released
danielroe Mar 1, 2023
0397bc3
Merge branch 'main' into main
danielroe Mar 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/3.api/4.advanced/1.hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Hook | Arguments | Description
`kit:compatibility` | `compatibility, issues` | Allows extending compatibility checks.
`ready` | `nuxt` | Called after Nuxt initialization, when the Nuxt instance is ready to work.
`close` | `nuxt` | Called when Nuxt instance is gracefully closing.
`restart` | - | Called to restart the current Nuxt instance. **This hook is currently only available on the [Edge Channel](/docs/guide/going-further/edge-channel/).** <!-- stabilityedge -->
`modules:before` | - | Called during Nuxt initialization, before installing user modules.
`modules:done` | - | Called during Nuxt initialization, after installing user modules.
`app:resolve` | `app` | Called after resolving the `app` instance.
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxi/src/commands/dev.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ export default defineNuxtCommand({
}

currentNuxt = await loadNuxt({ rootDir, dev: true, ready: false })
currentNuxt.hooks.hookOnce('restart', () => load(true))

if (!isRestart) {
showURL()
}
Expand Down
7 changes: 6 additions & 1 deletion packages/schema/src/types/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export interface NuxtHooks {
'kit:compatibility': (compatibility: NuxtCompatibility, issues: NuxtCompatibilityIssues) => HookResult

// Nuxt
/**
/**
* Called after Nuxt initialization, when the Nuxt instance is ready to work.
* @param nuxt The configured Nuxt object
* @returns Promise
Expand All @@ -73,6 +73,11 @@ export interface NuxtHooks {
* @returns Promise
*/
'close': (nuxt: Nuxt) => HookResult
/**
* Called to restart the current Nuxt instance.
* @returns Promise
*/
'restart': () => HookResult

/**
* Called during Nuxt initialization, before installing user modules.
Expand Down