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.

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

fix(nuxt): fully resolve nuxt dependencies #31436

Merged
merged 1 commit into from
Mar 18, 2025
Merged

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #31355

📚 Description

This creates + uses a nuxt runtimeDependencies list, as well as fully resolving as externals any dependencies nuxt requires

@danielroe danielroe self-assigned this Mar 18, 2025
Copy link

stackblitz bot commented Mar 18, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

coderabbitai bot commented Mar 18, 2025

Walkthrough

The pull request centralises and streamlines dependency management by replacing hardcoded lists with dynamic imports from a central meta module. The ESLint configuration now imports a set of runtime dependencies using a spread operator, avoiding static arrays. In the plugin for resolved externals, the dependency variable has been renamed and updated to reflect the new dynamic source, while also incorporating a new module path resolution step via an imported helper. The meta module itself has been updated to export the required runtime dependency list. Overall, the changes introduce a more unified and maintainable approach to handling runtime dependencies across the system.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 ca7f3a0 and 202d083.

📒 Files selected for processing (3)
  • eslint.config.mjs (2 hunks)
  • packages/nuxt/src/core/plugins/resolved-externals.ts (3 hunks)
  • packages/nuxt/src/meta.mjs (1 hunks)
🔇 Additional comments (7)
packages/nuxt/src/meta.mjs (1)

1-19: Excellent centralisation of runtime dependencies!

Creating a central list of runtime dependencies improves maintainability and makes dependency management more consistent across the codebase. The organisation into categories (other deps and unjs ecosystem) provides good clarity.

eslint.config.mjs (2)

8-9: Good approach using a centralised import

Importing the runtime dependencies from a centralised location helps maintain consistency and reduces duplication.


193-193: Clean implementation using spread operator

Using the spread operator to include all runtime dependencies is both elegant and maintainable. This approach ensures that ESLint configuration stays in sync with the centralised dependency list.

packages/nuxt/src/core/plugins/resolved-externals.ts (4)

5-7: Good modularisation with new imports

The addition of resolveModulePath from 'exsolve' and renaming the imported dependencies to runtimeNuxtDependencies improves clarity and separation of concerns.


17-18: Appropriate variable renaming for clarity

Renaming to runtimeNitroDependencies clearly distinguishes Nitro-specific dependencies from Nuxt dependencies, enhancing code readability.


21-29: Streamlined dependency management

The reorganisation of dependencies is well-structured:

  1. Explicitly listed critical dependencies
  2. Conditionally included Vue dependencies
  3. Added both Nuxt and Nitro runtime dependencies

This approach provides better separation of concerns whilst ensuring all necessary dependencies are included.


39-45: Enhanced module resolution logic

The added conditional block properly handles cases where the resolved ID matches the requested ID by applying module path resolution. The implementation correctly uses Nuxt options for configuration parameters.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • 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 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.

Sorry, something went wrong.

Copy link

pkg-pr-new bot commented Mar 18, 2025

Open in Stackblitz

@nuxt/kit

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

nuxt

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

@nuxt/schema

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

@nuxt/rspack-builder

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 202d083

Copy link

codspeed-hq bot commented Mar 18, 2025

CodSpeed Performance Report

Merging #31436 will not alter performance

Comparing fix/resolved-externals (202d083) with main (ca7f3a0)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 26d0e18 into main Mar 18, 2025
83 of 84 checks passed
@danielroe danielroe deleted the fix/resolved-externals branch March 18, 2025 22:44
@github-actions github-actions bot mentioned this pull request Mar 18, 2025
danielroe added a commit that referenced this pull request Mar 18, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@github-actions github-actions bot mentioned this pull request Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mismatching versions of ohash lead to hydration failures
2 participants