fix(kit,nuxt,schema): add trailing slash to some dir aliases #32755

danielroe · 2025-07-25T08:35:18Z

🔗 Linked issue

resolves #32220

📚 Description

because we check for a directory to exist to decide whether to generate directory-style types, it's difficult for directories like #shared or #build, which might not exist but have aliases pre-defined for them.

this allows hinting that an alias is a directory by adding a trailing slash to the respective nuxt alias

(this also adds a slight perf benefit as we don't have to hit the fs in this case)

wdyt @pi0 - shall we port this to nitro too?

bolt-new-by-stackblitz · 2025-07-25T08:35:21Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-25T08:37:56Z

Walkthrough

The changes standardise the handling of directory path aliases across several Nuxt-related packages by ensuring that certain paths consistently end with a trailing slash. This is achieved by introducing and applying the withTrailingSlash utility from the ufo package to relevant directory paths in configuration, template generation, and schema resolution. Adjustments are made in both source code and tests to reflect this new convention. Additionally, logic determining whether an alias is a directory is updated to consider both file system checks and the presence of a trailing slash in the alias string.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 2111b18 and ac4a04c.

📒 Files selected for processing (6)

packages/kit/src/loader/config.ts (3 hunks)
packages/kit/src/template.ts (1 hunks)
packages/kit/test/load-nuxt-config.spec.ts (1 hunks)
packages/nuxt/src/core/nitro.ts (1 hunks)
packages/nuxt/src/core/nuxt.ts (1 hunks)
packages/schema/src/config/common.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

packages/nuxt/src/core/nitro.ts
packages/nuxt/src/core/nuxt.ts
packages/kit/src/loader/config.ts
packages/kit/test/load-nuxt-config.spec.ts
packages/schema/src/config/common.ts
packages/kit/src/template.ts

**/*.{test,spec}.{ts,tsx,js,jsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Write unit tests for core functionality using vitest

Files:

packages/kit/test/load-nuxt-config.spec.ts

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

GitHub Check: code

🔇 Additional comments (10)

packages/kit/test/load-nuxt-config.spec.ts (1)

14-22: Test snapshot correctly updated to reflect trailing slash changes.

The inline snapshot has been properly updated to match the new behaviour where directory aliases consistently end with trailing slashes. This aligns with the PR objective of standardising directory path handling.

packages/kit/src/template.ts (1)

472-472: Excellent implementation of trailing slash directory detection.

The enhanced condition correctly implements the core feature of this PR by allowing aliases ending with '/' to be treated as directories without requiring filesystem checks. This addresses the issue with virtual directories like #shared or #build that may not physically exist whilst maintaining backwards compatibility with existing filesystem-based detection.

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

484-489: Consistent implementation of trailing slash directory detection for Nitro.

The logic correctly mirrors the implementation in template.ts by checking both filesystem stats and trailing slash presence to determine directory status. The clean boolean variable isDirectory makes the conditional wildcard path mapping clear and maintainable.

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

735-735: Proper standardisation of core app directory alias.

The withTrailingSlash() wrapper ensures the #app alias consistently ends with a trailing slash, aligning with the broader standardisation effort across all directory aliases in the codebase.

packages/kit/src/loader/config.ts (2)

13-13: Appropriate import of trailing slash utility.

The import of withTrailingSlash from the ufo package is the correct utility to use for ensuring consistent trailing slash behaviour across the codebase.

57-57: Consistent application of trailing slash standardisation to layer aliases.

The use of withTrailingSlash() for layer aliases ensures that directory paths in the configuration are consistently normalised. This addresses the core issue by allowing the system to recognise directory aliases without relying on filesystem existence checks.

Also applies to: 102-102

packages/schema/src/config/common.ts (4)

12-12: LGTM! Import statement is correctly placed.

The import of withTrailingSlash from the ufo package is appropriate for handling directory path standardisation.

204-205: Good practice: Using variables to avoid redundant function calls.

The introduction of srcWithTrailingSlash and rootWithTrailingSlash variables improves code readability and performance by avoiding repetitive calls to withTrailingSlash.

207-212: Excellent implementation of directory alias standardisation.

The selective application of withTrailingSlash to directory aliases while leaving file aliases unchanged demonstrates a clear understanding of the requirements. This change will help the system recognise directory aliases without requiring file system existence checks, which aligns perfectly with the PR objectives.

207-213: Consistent and correct implementation across all aliases.

The changes demonstrate excellent consistency by applying trailing slashes only to directory aliases (~, @, ~~, @@, #shared, #build) whilst correctly preserving the file alias (#internal/nuxt/paths) without modification. This selective approach shows good understanding of when trailing slashes are appropriate.

✨ 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/dir-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 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.

socket-security · 2025-07-25T09:18:45Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	strip-literal@3.0.0
	uncrypto@0.1.3
	radix3@1.1.2
	klona@2.0.6
	playwright-core@1.54.1
	ofetch@1.4.1
	ufo@1.6.1
	std-env@3.9.0
	mlly@1.7.4
	postcss@8.5.6
	pathe@2.0.3
	semver@7.7.2
	magic-string@0.30.17
	typescript@5.8.3

View full report

pkg-pr-new · 2025-07-25T09:19:29Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: cad6735

codspeed-hq · 2025-07-25T09:30:23Z

CodSpeed Performance Report

Merging #32755 will not alter performance

_{Comparing fix/dir-aliases (cad6735) with main (c4317e0)¹}

Summary

✅ 10 untouched benchmarks

No successful run was found on main (2111b18) during the generation of this report, so c4317e0 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

danielroe added 4 commits July 25, 2025 09:22

fix(kit,nuxt,schema): generate non-existent alias directory types

19fc969

fix(kit): also add trailing slash for layers

526eea2

perf: do same for #app

455bbb9

chore: lint

ac4a04c

danielroe self-assigned this Jul 25, 2025

danielroe added the types label Jul 25, 2025

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

chore: add ufo as a dependency

cad6735

danielroe merged commit d8d2f3e into main Jul 25, 2025
47 checks passed

danielroe deleted the fix/dir-aliases branch July 25, 2025 10:00

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

v4.0.2 #32710

Merged

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

fix(kit,nuxt,schema): add trailing slash to some dir aliases (#32755)

6107ebb

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

v3.18.0 #32713

Merged

OrbisK mentioned this pull request Jul 26, 2025

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(kit,nuxt,schema): add trailing slash to some dir aliases #32755

fix(kit,nuxt,schema): add trailing slash to some dir aliases #32755

Uh oh!

danielroe commented Jul 25, 2025

Uh oh!

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

Uh oh!

coderabbitai bot commented Jul 25, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

socket-security bot commented Jul 25, 2025

Uh oh!

pkg-pr-new bot commented Jul 25, 2025

Uh oh!

codspeed-hq bot commented Jul 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(kit,nuxt,schema): add trailing slash to some dir aliases #32755

fix(kit,nuxt,schema): add trailing slash to some dir aliases #32755

Uh oh!

Conversation

danielroe commented Jul 25, 2025

🔗 Linked issue

📚 Description

Uh oh!

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

Uh oh!

coderabbitai bot commented Jul 25, 2025

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

socket-security bot commented Jul 25, 2025

Uh oh!

pkg-pr-new bot commented Jul 25, 2025

Uh oh!

codspeed-hq bot commented Jul 25, 2025

CodSpeed Performance Report

Merging #32755 will not alter performance

Summary

Footnotes

Uh oh!

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)