fix(nuxt): allow modules to add to `typescript.hoist` #32601

danielroe · 2025-07-13T20:55:35Z

🔗 Linked issue

📚 Description

this allows modules to push to typescript.hoist for key dependencies which they expect users to be able to import from or augment.

bolt-new-by-stackblitz · 2025-07-13T20:55:39Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-13T20:57:16Z

Walkthrough

The update restructures the TypeScript type path resolution process within the initNuxt function by introducing a new asynchronous helper function, resolveTypescriptPaths. This function consolidates the logic for mapping hoisted package names to their resolved type paths, handling exclusions and nightly package aliases. The path resolution is now performed lazily within relevant hooks (nitro:config and prepare:types), with the latter hook updated to be asynchronous. The regular expression NESTED_PKG_RE is relocated for reuse. No changes are made to the underlying package resolution or filtering logic, but the structure and timing of path resolution are modified.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/hoist

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.
- @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 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.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/nuxt/src/core/nuxt.ts (1)
981-1009: Well-structured TypeScript path resolution function.

The extracted function properly handles:

Nested package resolution using the regex pattern

Exclusion of packages present in package.json dependencies

Nightly package aliasing with deduplication

Efficient flattening of Promise results

The function signature and implementation align well with TypeScript conventions and the PR objectives.

Consider adding JSDoc comments for better documentation:
+/**
+ * Resolves TypeScript path mappings for hoisted packages
+ * @param nuxt - The Nuxt instance
+ * @returns Promise resolving to TypeScript path mappings
+ */
 async function resolveTypescriptPaths (nuxt: Nuxt): Promise<Record<string, [string]>> {

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 36a6df7 and 8a29157.

📒 Files selected for processing (1)

packages/nuxt/src/core/nuxt.ts (3 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

**/*.{ts,tsx,vue}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

🧠 Learnings (2)

📓 Common learnings

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

Learnt from: GalacticHypernova
PR: nuxt/nuxt#29661
File: packages/kit/src/template.ts:227-229
Timestamp: 2024-11-28T21:22:40.496Z
Learning: In `packages/kit/src/template.ts`, when updating the `EXTENSION_RE` regular expression for TypeScript configuration, avoid using patterns like `(\.\w+)+$` as they can result in catastrophic backtracking.

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.vue : Use `<script setup lang="ts">` and the composition API when creating Vue components

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{ts,tsx} : Follow standard TypeScript conventions and best practices

Learnt from: TheAlexLichter
PR: nuxt/nuxt#31812
File: packages/nuxt/src/components/plugins/islands-transform.ts:202-202
Timestamp: 2025-04-18T18:33:41.753Z
Learning: In Nuxt, using `rolldownVersion` (not `rollupVersion`) is intentional when detecting if rolldown-vite is being used, even though TypeScript may show an error because the property isn't in standard type definitions yet.

packages/nuxt/src/core/nuxt.ts (7)

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

Learnt from: GalacticHypernova
PR: nuxt/nuxt#29661
File: packages/kit/src/template.ts:227-229
Timestamp: 2024-11-28T21:22:40.496Z
Learning: In `packages/kit/src/template.ts`, when updating the `EXTENSION_RE` regular expression for TypeScript configuration, avoid using patterns like `(\.\w+)+$` as they can result in catastrophic backtracking.

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{ts,tsx} : Follow standard TypeScript conventions and best practices

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.vue : Use `<script setup lang="ts">` and the composition API when creating Vue components

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{ts,tsx,vue} : Remove code that is not used or needed

Learnt from: TheAlexLichter
PR: nuxt/nuxt#31812
File: packages/nuxt/src/components/plugins/islands-transform.ts:202-202
Timestamp: 2025-04-18T18:33:41.753Z
Learning: In Nuxt, using `rolldownVersion` (not `rollupVersion`) is intentional when detecting if rolldown-vite is being used, even though TypeScript may show an error because the property isn't in standard type definitions yet.

⏰ 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: codeql (actions)
GitHub Check: codeql (javascript-typescript)
GitHub Check: build
GitHub Check: code

🔇 Additional comments (3)

packages/nuxt/src/core/nuxt.ts (3)

222-228: Excellent refactoring with proper lazy initialisation.

The lazy initialisation pattern with paths ||= await resolveTypescriptPaths(nuxt) efficiently prevents redundant path resolution whilst ensuring the paths are available when needed in the nitro:config hook.

231-231: Correctly updated hook to async for path resolution.

Making the prepare:types hook asynchronous is necessary to properly await the TypeScript path resolution.

253-253: Consistent lazy initialisation pattern.

The same lazy initialisation approach is used here as in the nitro:config hook, ensuring consistent behaviour and avoiding duplicate path resolution.

pkg-pr-new · 2025-07-13T21:03:32Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 8a29157

codspeed-hq · 2025-07-13T21:09:35Z

CodSpeed Performance Report

Merging #32601 will not alter performance

_{Comparing fix/hoist (8a29157) with main (36a6df7)}

Summary

✅ 10 untouched benchmarks

BobbieGoede

Great! Tested with storybook reproduction project.

BobbieGoede · 2025-07-13T21:11:18Z

Tests flaky or did something actually break?

danielroe · 2025-07-13T21:19:33Z

flaky tests for some reason

### 🔗 Linked issue * #920  ### 📚 Description With nuxt/nuxt#32601 merged, the related issue will be resolved for projects using nuxt 4. This will also improve/add support for the directory structure in nuxt 4 as the `.storybook` directory is outside the app/server directories and needs to be added manually by this module. ~~If we also want this resolved for projects using nuxt 3, the PR will either need to be backported (ideal) or we could use my package nuxt-module-utils (I have not done so in this PR, I don't want to be pushy with my own packages 😂).~~ (this is not relevant since the separated tsconfig structure is nuxt 4 only)   --------- Co-authored-by: Tobias Diez <code@tobiasdiez.de>

fix(nuxt): allow modules to add to typescript.hoist

8a29157

danielroe requested a review from BobbieGoede July 13, 2025 20:55

danielroe self-assigned this Jul 13, 2025

github-actions bot added 4.x bug labels Jul 13, 2025

coderabbitai bot reviewed Jul 13, 2025

View reviewed changes

BobbieGoede approved these changes Jul 13, 2025

View reviewed changes

danielroe merged commit ba5ea31 into main Jul 13, 2025
117 of 121 checks passed

danielroe deleted the fix/hoist branch July 13, 2025 21:33

github-actions bot mentioned this pull request Jul 13, 2025

v4.0.0 #27716

Merged

BobbieGoede mentioned this pull request Jul 14, 2025

fix: include config dir in tsconfig nuxt-modules/storybook#926

Merged

danielroe added a commit that referenced this pull request Jul 21, 2025

fix(nuxt): allow modules to add to typescript.hoist (#32601)

01f3822

This was referenced Jul 21, 2025

v3.17.8 #32610

Closed

v3.18.0 #32713

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): allow modules to add to `typescript.hoist` #32601

fix(nuxt): allow modules to add to `typescript.hoist` #32601

Uh oh!

danielroe commented Jul 13, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jul 13, 2025

Uh oh!

coderabbitai bot commented Jul 13, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

pkg-pr-new bot commented Jul 13, 2025

Uh oh!

codspeed-hq bot commented Jul 13, 2025

Uh oh!

BobbieGoede left a comment

Uh oh!

BobbieGoede commented Jul 13, 2025

Uh oh!

danielroe commented Jul 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): allow modules to add to typescript.hoist #32601

fix(nuxt): allow modules to add to typescript.hoist #32601

Uh oh!

Conversation

danielroe commented Jul 13, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jul 13, 2025

Uh oh!

coderabbitai bot commented Jul 13, 2025

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Jul 13, 2025

Uh oh!

codspeed-hq bot commented Jul 13, 2025

CodSpeed Performance Report

Merging #32601 will not alter performance

Summary

Uh oh!

BobbieGoede left a comment

Choose a reason for hiding this comment

Uh oh!

BobbieGoede commented Jul 13, 2025

Uh oh!

danielroe commented Jul 13, 2025

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): allow modules to add to `typescript.hoist` #32601

fix(nuxt): allow modules to add to `typescript.hoist` #32601

CodeRabbit Configuration File (`.coderabbit.yaml`)