fix(kit,vite): ensure all `modulesDir` paths are added to `fs.allow` #31540

danielroe · 2025-03-26T12:38:08Z

🔗 Linked issue

resolves #31311

📚 Description

this bundles two changes:

more accurately resolves node_modules folder when a module is not within node_modules/ (e.g. local modules)
passes modulesDir to fs.allow later on, which accounts for intervening changes (modules being pushed to modulesDir after the schema is initially resolved)

bolt-new-by-stackblitz · 2025-03-26T12:38:12Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-03-26T12:40:36Z

Walkthrough

The pull request introduces several modifications across the codebase. In one area, the module installation logic has been adjusted to refine how the module root is determined. A new function call to resolve the package JSON file is now incorporated when necessary, which simplifies the determination of the installed module directory. In addition, the configuration for allowed file system directories has been revised by removing the modules directory from the resolved array. Meanwhile, within the bundler component, the modules directory configured in the options is now explicitly spread into the allowed directories array. Publicly exposed method signatures and export declarations remain unchanged. These adjustments focus on standardising and simplifying the logic for resolving module paths and directory configurations.

📜 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 4087ddc and 98df3b7.

📒 Files selected for processing (3)

packages/kit/src/module/install.ts (2 hunks)
packages/schema/src/config/vite.ts (1 hunks)
packages/vite/src/vite.ts (1 hunks)

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

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

🔇 Additional comments (5)

packages/vite/src/vite.ts (1)

40-40: Ensure all module directories are accessible to Vite

This addition ensures that all directories in nuxt.options.modulesDir are explicitly included in the allowed filesystem directories for Vite. This resolves an issue where modules located outside standard locations (like local modules) were not accessible to Vite during build time.

packages/schema/src/config/vite.ts (1)

117-125: Removed modulesDir from the schema resolver

The removal of modulesDir from the schema resolution is deliberate and correct. This change is paired with the explicit inclusion of modulesDir in the allowDirs array in packages/vite/src/vite.ts.

This approach allows for more accurate handling of module directories, especially when modules are dynamically added to modulesDir after the initial schema resolution.

packages/kit/src/module/install.ts (3)

4-5: Added join function import

The addition of join from the pathe library is necessary for the refactored module resolution logic. This allows for more accurate path joining operations when handling module directories.

10-10: Added resolvePackageJSON import

This import enables the improved module resolution logic that can now find the proper module root by resolving the package.json file, particularly important for non-standard module locations.

43-50: Improved module root resolution

This refactored logic significantly improves how module roots are determined, especially for modules outside standard locations:

It now attempts to resolve the package.json file when the parsed directory is not available

It simplifies the directory path calculation

It uses join instead of resolve for a more accurate path construction when adding to modulesDir

This change enhances compatibility with local modules and other non-standard module locations.

✨ 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 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-03-26T12:52:07Z

Open in Stackblitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 98df3b7

codspeed-hq · 2025-03-26T12:52:40Z

CodSpeed Performance Report

Merging #31540 will not alter performance

_{Comparing fix/fs-allow (98df3b7) with main (4087ddc)}

Summary

✅ 10 untouched benchmarks

davidstackio · 2025-03-26T16:19:00Z

@danielroe Saw the GitHub actions bot mention this for 4.x release. Not really sure how that action works - does that mean it'll be released only in that one, or in a 3.x patch? Or both?

Wondering if I need to temporarily switch to edge channel in my package.json, or if I could just wait a few days for the patch. TY!

PS Thanks for the quick PR for this issue :)

danielroe · 2025-03-26T17:19:18Z

it'll come to the next v3 patch (this weekend)

acidjazz · 2025-03-26T17:25:37Z

awesome work @danielroe

…31540)

danielroe added 2 commits March 26, 2025 11:41

fix(kit): resolve module paths from package.json location

5887c78

fix(vite): add all modulesDir to fs.allow

98df3b7

github-actions bot added 3.x bug labels Mar 26, 2025

danielroe merged commit 841fec7 into main Mar 26, 2025
47 checks passed

danielroe deleted the fix/fs-allow branch March 26, 2025 13:41

github-actions bot mentioned this pull request Mar 26, 2025

v4.0.0 #27716

Draft

danielroe added a commit that referenced this pull request Apr 1, 2025

fix(kit,vite): ensure all modulesDir paths are added to fs.allow (#…

2fcb76b

…31540)

This was referenced Apr 1, 2025

v3.16.3 #31626

Closed

v3.17.0 #31687

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(kit,vite): ensure all `modulesDir` paths are added to `fs.allow` #31540

fix(kit,vite): ensure all `modulesDir` paths are added to `fs.allow` #31540

Uh oh!

danielroe commented Mar 26, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Mar 26, 2025

Uh oh!

coderabbitai bot commented Mar 26, 2025

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 Mar 26, 2025

Uh oh!

codspeed-hq bot commented Mar 26, 2025

Uh oh!

Uh oh!

davidstackio commented Mar 26, 2025

Uh oh!

danielroe commented Mar 26, 2025

Uh oh!

acidjazz commented Mar 26, 2025

Uh oh!

Uh oh!

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

Uh oh!

fix(kit,vite): ensure all modulesDir paths are added to fs.allow #31540

fix(kit,vite): ensure all modulesDir paths are added to fs.allow #31540

Uh oh!

Conversation

danielroe commented Mar 26, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Mar 26, 2025

Uh oh!

coderabbitai bot commented Mar 26, 2025

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 Mar 26, 2025

Uh oh!

codspeed-hq bot commented Mar 26, 2025

CodSpeed Performance Report

Merging #31540 will not alter performance

Summary

Uh oh!

Uh oh!

davidstackio commented Mar 26, 2025

Uh oh!

danielroe commented Mar 26, 2025

Uh oh!

acidjazz commented Mar 26, 2025

Uh oh!

Uh oh!

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

fix(kit,vite): ensure all `modulesDir` paths are added to `fs.allow` #31540

fix(kit,vite): ensure all `modulesDir` paths are added to `fs.allow` #31540

CodeRabbit Configuration File (`.coderabbit.yaml`)