feat(kit): add `onInstall` and `onUpgrade` module hooks #32397

romhml · 2025-06-15T12:22:39Z

🔗 Linked issue

Resolves #31070

📚 Description

Adds onInstall and onUpgrade module hooks to let modules perform additional setup steps when installed or upgraded. These hooks are defined in the module definition:

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    version: '1.0.0',
  },

  onInstall () {
    // This will be run when the module is first installed.
  },

  onUpgrade () {
    // This will be run when the module is upgraded.
  }
})

Note that the name and version fields must be provided in the module's metadata for these hooks to be executed.

The implementation uses the .nuxtrc file internally to detect when hooks must be executed. It logs the module's version as setups.my-module="1.0.0" after a hook is executed, ensuring that the correct hook is triggered when the module is updated or installed.

Possible follow-ups:

We could add a onUninstall hook which would be run when a module is removed (if it is still available).
We could add support for rc files into @unjs/c12's updateConfig function to make the implementation here a bit more straightforward.
The nuxi module add command could also be updated to run the onInstall hook.

bolt-new-by-stackblitz · 2025-06-15T12:22:41Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-06-15T12:23:47Z

Walkthrough

Adds two optional lifecycle hooks, onInstall and onUpgrade, to module typings and the normalized module object. The module install workflow now reads module metadata and a .nuxtrc file, invokes onInstall for first-time installs and onUpgrade when semver detects a newer version, logs errors, and updates .nuxtrc before module invocation. A test module implementing these hooks and a sequential test suite exercising install, idempotent install, and upgrade scenarios were added. No public function signatures were changed.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0af7308 and db42300.

📒 Files selected for processing (1)

packages/kit/src/module/install.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/kit/src/module/install.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: build
GitHub Check: codeql (javascript-typescript)
GitHub Check: codeql (actions)
GitHub Check: code

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-06-15T12:29:14Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32397

nuxt

npm i https://pkg.pr.new/nuxt@32397

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32397

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32397

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32397

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32397

commit: db42300

HigherOrderLogic · 2025-06-15T12:30:49Z

packages/kit/src/module/install.ts

+    if (!previousVersion) {
+      await nuxtModule?.onInstall?.(nuxt)
+    } else if (semver.gt(meta.version, previousVersion)) {
+      await nuxtModule?.onUpgrade?.(inlineOptions, nuxt, previousVersion)
+    }


Maybe try catching error here and tell the user what went wrong, then exit later?

codspeed-hq · 2025-06-15T12:40:38Z

CodSpeed Performance Report

Merging #32397 will not alter performance

_{Comparing romhml:feat/module-install-hooks (db42300) with main (9674aaf)}

Summary

✅ 10 untouched benchmarks

…ooks

romhml requested a review from danielroe as a code owner June 15, 2025 12:22

github-actions bot added 4.x enhancement labels Jun 15, 2025

romhml force-pushed the feat/module-install-hooks branch from 3f5c834 to 3fbcbdd Compare June 15, 2025 12:23

feat(kit): add onInstall and onUpgrade module hooks

09d23d5

romhml force-pushed the feat/module-install-hooks branch from 3fbcbdd to 09d23d5 Compare June 15, 2025 12:25

HigherOrderLogic reviewed Jun 15, 2025

View reviewed changes

romhml added 2 commits June 15, 2025 14:46

fix(kit): onUpgrade module signature

99945df

feat(kit): improve module hooks error handling

6534125

danielroe added this to the 3.18 milestone Jun 25, 2025

danielroe mentioned this pull request Jul 8, 2025

CLI Wizard nuxt/cli#53

Closed

danielroe added 2 commits August 11, 2025 22:05

Merge remote-tracking branch 'origin/main' into feat/module-install-h…

0af7308

…ooks

perf(kit): only read meta if hooks are present

db42300

danielroe merged commit 2633988 into nuxt:main Aug 12, 2025
82 of 84 checks passed

github-actions bot mentioned this pull request Aug 11, 2025

v4.1.0 #32938

Merged

danielroe mentioned this pull request Aug 12, 2025

test: simplify module hook tests #32950

Merged

danielroe pushed a commit that referenced this pull request Sep 2, 2025

feat(kit): add onInstall and onUpgrade module hooks (#32397)

2b8b156

github-actions bot mentioned this pull request Sep 2, 2025

v3.19.0 #33114

Merged

coderabbitai bot mentioned this pull request Dec 18, 2025

feat(nuxt): add option to disable modules from layers #33883

Merged

coderabbitai bot mentioned this pull request Jan 2, 2026

fix(kit,schema): align module onUpgrade arguments with types #33988

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(kit): add `onInstall` and `onUpgrade` module hooks #32397

feat(kit): add `onInstall` and `onUpgrade` module hooks #32397

Uh oh!

romhml commented Jun 15, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jun 15, 2025

Uh oh!

coderabbitai bot commented Jun 15, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 15, 2025 •

edited

Loading

Uh oh!

HigherOrderLogic Jun 15, 2025

Uh oh!

codspeed-hq bot commented Jun 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat(kit): add onInstall and onUpgrade module hooks #32397

feat(kit): add onInstall and onUpgrade module hooks #32397

Uh oh!

Conversation

romhml commented Jun 15, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jun 15, 2025

Uh oh!

coderabbitai bot commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HigherOrderLogic Jun 15, 2025

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #32397 will not alter performance

Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat(kit): add `onInstall` and `onUpgrade` module hooks #32397

feat(kit): add `onInstall` and `onUpgrade` module hooks #32397

coderabbitai bot commented Jun 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Jun 15, 2025 •

edited

Loading

codspeed-hq bot commented Jun 15, 2025 •

edited

Loading