fix(nuxt): expose shared aliases within `shared/` dir #32676

danielroe · 2025-07-18T15:06:20Z

🔗 Linked issue

resolves #32556

📚 Description

this checks for aliases which are shared between nuxt + nitro and includes them in the shared tsconfig.json

bolt-new-by-stackblitz · 2025-07-18T15:06:23Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-18T15:08:36Z

Walkthrough

A new internal block was added to the Nuxt core's prepare:types hook to synchronise TypeScript path aliases between Nuxt and Nitro by copying shared aliases into the shared TypeScript configuration during type preparation. Additionally, a new test fixture file was introduced that exports a constant string, and a corresponding Vitest test was added to verify the type correctness and alias resolution for this exported value. No changes were made to exported or public entity declarations in the core code; the updates are limited to internal logic and test files.

📜 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 a6bc840 and 0dc88fb.

📒 Files selected for processing (3)

packages/nuxt/src/core/nitro.ts (1 hunks)
test/fixtures/basic-types/shared/other.ts (1 hunks)
test/fixtures/basic-types/shared/shared-types.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{test,spec}.{ts,tsx} : Write unit tests for core functionality using vitest

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

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.e2e.{ts,js} : Write end-to-end tests using Playwright and @nuxt/test-utils

test/fixtures/basic-types/shared/shared-types.ts (3)

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{test,spec}.{ts,tsx} : Write unit tests for core functionality using vitest

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 **/*.e2e.{ts,js} : Write end-to-end tests using Playwright and @nuxt/test-utils

test/fixtures/basic-types/shared/other.ts (3)

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{test,spec}.{ts,tsx} : Write unit tests for core functionality using vitest

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 **/*.{ts,tsx,vue} : Add comments only to explain complex logic or non-obvious implementations

packages/nuxt/src/core/nitro.ts (4)

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: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

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

🧬 Code Graph Analysis (1)

test/fixtures/basic-types/shared/shared-types.ts (1)

test/fixtures/basic-types/shared/other.ts (1)

foo (1-1)

⏰ 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). (3)

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

🔇 Additional comments (3)

test/fixtures/basic-types/shared/other.ts (1)

1-1: LGTM! Simple test fixture for shared alias validation.

This minimal export provides a perfect test case for verifying that shared aliases work correctly between Nuxt and Nitro environments.

packages/nuxt/src/core/nitro.ts (1)

633-646: LGTM! Well-implemented shared alias synchronisation.

The implementation correctly identifies aliases that are shared between Nuxt and Nitro configurations and copies them to the shared TypeScript configuration. The logic handles both base aliases and their wildcard variants (alias/*), ensuring comprehensive type resolution support.

The defensive initialisation of opts.sharedTsConfig.compilerOptions and opts.sharedTsConfig.compilerOptions.paths prevents potential runtime errors.

test/fixtures/basic-types/shared/shared-types.ts (1)

1-10: LGTM! Comprehensive test coverage for shared alias functionality.

This test effectively validates the shared alias implementation by:

Importing from the shared module using the #shared/other alias

Verifying proper type resolution (not any)

Confirming the exact type matches the expected string

The test design aligns with Vitest best practices and provides confidence that the shared alias configuration works correctly across both Nuxt and Nitro environments.

✨ 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/shared-aliases

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.

pkg-pr-new · 2025-07-18T15:09:57Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 0dc88fb

codspeed-hq · 2025-07-18T15:21:23Z

CodSpeed Performance Report

Merging #32676 will not alter performance

_{Comparing fix/shared-aliases (0dc88fb) with main (a6bc840)}

Summary

✅ 10 untouched benchmarks

danielroe added 2 commits July 18, 2025 17:02

fix(nuxt): expose shared aliases within shared/ dir

60bead6

chore: remove unused function

0dc88fb

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

danielroe added bug 🔨 p3-minor labels Jul 18, 2025

danielroe merged commit 9193b32 into main Jul 18, 2025
82 of 84 checks passed

danielroe deleted the fix/shared-aliases branch July 18, 2025 16:45

This was referenced Jul 18, 2025

v4.0.1 #32641

Merged

v4.0.1 #32705

Closed

This was referenced Jul 25, 2025

Add alias to shared tsconfig #32634

Closed

Cant use #shared inside the shared folder #32765

Closed

chrisbbreuer mentioned this pull request Aug 15, 2025

chore(deps): update dependency @nuxt/kit to 4.0.3 stacksjs/ts-maps#43

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): expose shared aliases within `shared/` dir #32676

fix(nuxt): expose shared aliases within `shared/` dir #32676

Uh oh!

danielroe commented Jul 18, 2025

Uh oh!

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

Uh oh!

coderabbitai bot commented Jul 18, 2025

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 Jul 18, 2025

Uh oh!

codspeed-hq bot commented Jul 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): expose shared aliases within shared/ dir #32676

fix(nuxt): expose shared aliases within shared/ dir #32676

Uh oh!

Conversation

danielroe commented Jul 18, 2025

🔗 Linked issue

📚 Description

Uh oh!

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

Uh oh!

coderabbitai bot commented Jul 18, 2025

Walkthrough

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 Jul 18, 2025

Uh oh!

codspeed-hq bot commented Jul 18, 2025

CodSpeed Performance Report

Merging #32676 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): expose shared aliases within `shared/` dir #32676

fix(nuxt): expose shared aliases within `shared/` dir #32676

CodeRabbit Configuration File (`.coderabbit.yaml`)