feat(kit,schema): new `enforceModuleCompatibility` feature #31657

huang-julien · 2025-04-02T20:44:18Z

🔗 Linked issue

📚 Description

with nuxt/cli#818 , we can freely throw errors when Nuxt loads.

This PR improves DX by throwing an error when a module is not compatible with the current version of Nuxt. We've seen issues with people being surprised by modules (nuxt/scripts) being disabled due to compatiblity.

bolt-new-by-stackblitz · 2025-04-02T20:44:21Z

Run & review this pull request in StackBlitz Codeflow.

huang-julien · 2025-04-02T20:44:50Z

packages/schema/src/config/experimental.ts

+    /**
+     * Whether Nuxt should stop if a Nuxt module is incompatible.
+     */
+    enforceModuleCompatibility: false,


Maybe can this be moved into future instead and be enabled by default for v4 ?

Let's enable it by default for v4 (in the experimental namespace), and document in the migration guide. This can be done in a patch release if necessary.

coderabbitai · 2025-04-02T20:46:34Z

Walkthrough

The pull request introduces a refined error handling mechanism in the _defineNuxtModule function to address module compatibility issues. If the nuxt.options.experimental.enforceModuleCompatibility flag is enabled, a ModuleCompatibilityError is thrown, interrupting normal execution. If the flag is not enabled, the function retains its previous behaviour of logging a warning. Additionally, a new property, enforceModuleCompatibility, is added to the experimental section of the exported object in the defineResolvers function, which is initialised to false. This property allows users to control whether execution should halt in the event of incompatible modules. No changes have been made to the declarations of exported or public entities.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 c1c796c and cec5981.

📒 Files selected for processing (2)

packages/kit/src/module/define.ts (1 hunks)
packages/schema/src/config/experimental.ts (1 hunks)

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

packages/schema/src/config/experimental.ts
packages/kit/src/module/define.ts

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: codeql (actions)
GitHub Check: code

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @coderabbitai modularize this function.
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 generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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-04-02T20:48:18Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: cec5981

codspeed-hq · 2025-04-02T20:58:32Z

CodSpeed Performance Report

Merging #31657 will not alter performance

_{Comparing feat/enforce_module_compat (cec5981) with main (c3dea6a)}

Summary

✅ 10 untouched benchmarks

…ompat

…31657)

feat(kit,schema): new enforceModuleCompatibility feature

c1c796c

huang-julien requested a review from danielroe as a code owner April 2, 2025 20:44

github-actions bot added 3.x enhancement labels Apr 2, 2025

huang-julien commented Apr 2, 2025

View reviewed changes

huang-julien added the dx label Apr 2, 2025

danielroe added 2 commits April 14, 2025 11:56

refactor: extract message out

9f8da7d

Merge remote-tracking branch 'origin/main' into feat/enforce_module_c…

cec5981

…ompat

danielroe approved these changes Apr 14, 2025

View reviewed changes

danielroe merged commit ff35428 into main Apr 14, 2025
46 checks passed

danielroe deleted the feat/enforce_module_compat branch April 14, 2025 11:54

github-actions bot mentioned this pull request Apr 14, 2025

v4.0.0 #27716

Merged

danielroe pushed a commit that referenced this pull request Apr 14, 2025

feat(kit,schema): allow throwing error if modules aren't compatible (#…

c9e39ee

…31657)

github-actions bot mentioned this pull request Apr 14, 2025

v3.17.0 #31687

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(kit,schema): new `enforceModuleCompatibility` feature #31657

feat(kit,schema): new `enforceModuleCompatibility` feature #31657

Uh oh!

huang-julien commented Apr 2, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Apr 2, 2025

Uh oh!

huang-julien Apr 2, 2025

Uh oh!

danielroe Apr 14, 2025

Uh oh!

coderabbitai bot commented Apr 2, 2025 •

edited

Loading

Chat

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 Apr 2, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Apr 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

feat(kit,schema): new enforceModuleCompatibility feature #31657

feat(kit,schema): new enforceModuleCompatibility feature #31657

Uh oh!

Conversation

huang-julien commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Apr 2, 2025

Uh oh!

huang-julien Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

danielroe Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Walkthrough

Chat

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 Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

CodSpeed Performance Report

Merging #31657 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

feat(kit,schema): new `enforceModuleCompatibility` feature #31657

feat(kit,schema): new `enforceModuleCompatibility` feature #31657

huang-julien commented Apr 2, 2025 •

edited

Loading

coderabbitai bot commented Apr 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Apr 2, 2025 •

edited

Loading

codspeed-hq bot commented Apr 2, 2025 •

edited

Loading