fix(kit): resolve to directories in `resolvePath` too and normalize file extensions #32857

cernymatej · 2025-08-04T23:53:17Z

📚 Description

This PR adds a way to specify the target path type (file or a directory) in resolvePath and ensures that the provided file extensions are normalized.

… extensions

bolt-new-by-stackblitz · 2025-08-04T23:53:39Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-08-04T23:56:07Z

Walkthrough

The updates introduce a type option to the ResolvePathOptions interface, allowing explicit specification of whether a path resolution should target a file or a directory, with 'file' as the default. The internal logic of the resolvePath and _resolvePathGranularly functions is refactored to consistently use this type option, affecting how extensions and module path resolution are handled. The findPath function is updated for compatibility with the new option. A PathType type alias is added, and a utility type RequirePicked is introduced in a separate utility file.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 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 84816d8 and 766dbb7.

📒 Files selected for processing (2)

packages/kit/src/resolve.ts (7 hunks)
packages/kit/src/utils.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{ts,tsx}

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

Follow standard TypeScript conventions and best practices

Files:

packages/kit/src/utils.ts
packages/kit/src/resolve.ts

🧠 Learnings (5)

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

📚 Learning: in `packages/kit/src/template.ts`, when updating the `extension_re` regular expression for typescrip...

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.

Applied to files:

packages/kit/src/utils.ts
packages/kit/src/resolve.ts

📚 Learning: in `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distdir` are l...

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.

Applied to files:

packages/kit/src/utils.ts
packages/kit/src/resolve.ts

📚 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-07-18T16:46:07.446Z
Learning: Applies to **/*.{ts,tsx} : Follow standard TypeScript conventions and best practices

Applied to files:

packages/kit/src/resolve.ts

📚 Learning: in `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally im...

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.

Applied to files:

packages/kit/src/resolve.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). (3)

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

🔇 Additional comments (9)

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

25-25: Well-implemented utility type!

The RequirePicked type is a useful addition that correctly leverages TypeScript's utility types to make specified keys required whilst preserving the rest of the type structure.

packages/kit/src/resolve.ts (8)

11-11: Import statement correctly updated.

The addition of RequirePicked to the imports is appropriate as it's used in the _resolvePathGranularly function signature.

20-44: Well-documented interface enhancements.

The addition of the type property and clarification of the extensions behaviour are clear improvements. The documentation accurately describes the behaviour and default values.

47-63: Correct implementation of type-aware path resolution.

The function properly handles the new type option with appropriate defaults and maintains backwards compatibility with the fallback behaviour.

144-144: Clear type definition for path types.

The PathType type alias improves type safety and code clarity.

180-183: Useful extension normalisation helper.

The normalizeExtension function correctly ensures extensions always start with a dot, handling both formats gracefully.

184-184: Excellent use of RequirePicked for type safety.

Using RequirePicked<ResolvePathOptions, 'type'> ensures the type property is always defined, eliminating the need for runtime checks and improving type safety.

217-247: Well-structured file-specific resolution logic.

The refactoring correctly:

Limits extension checking to file resolution only

Normalises extensions consistently using the new helper

Appropriately restricts module path resolution to files

This aligns perfectly with the PR objectives.

148-148: Appropriate type property update.

Making the type property optional correctly reflects that not all resolution attempts will have a determined type (e.g., when the path doesn't exist).

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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

Support

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

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.

pkg-pr-new · 2025-08-04T23:57:02Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 766dbb7

codspeed-hq · 2025-08-05T00:07:45Z

CodSpeed Performance Report

Merging #32857 will not alter performance

_{Comparing cernymatej:fix/kit-resolve-path (766dbb7) with main (84816d8)}

Summary

✅ 10 untouched benchmarks

fix(kit): resolve directories in resolvePath too and normalize file…

766dbb7

… extensions

cernymatej requested a review from danielroe as a code owner August 4, 2025 23:53

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

cernymatej changed the title ~~fix(kit): resolve directories in resolvePath too and normalize file extensions~~ fix(kit): resolve to directories in resolvePath too and normalize file extensions Aug 5, 2025

danielroe approved these changes Aug 11, 2025

View reviewed changes

danielroe merged commit 745f572 into nuxt:main Aug 11, 2025
120 of 123 checks passed

github-actions bot mentioned this pull request Aug 11, 2025

v4.1.0 #32938

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(kit): resolve to directories in `resolvePath` too and normalize file extensions #32857

fix(kit): resolve to directories in `resolvePath` too and normalize file extensions #32857

cernymatej commented Aug 4, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Aug 4, 2025

Uh oh!

coderabbitai bot commented Aug 4, 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 Aug 4, 2025

Uh oh!

codspeed-hq bot commented Aug 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(kit): resolve to directories in resolvePath too and normalize file extensions #32857

fix(kit): resolve to directories in resolvePath too and normalize file extensions #32857

Conversation

cernymatej commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Aug 4, 2025

Uh oh!

coderabbitai bot commented Aug 4, 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!

pkg-pr-new bot commented Aug 4, 2025

Uh oh!

codspeed-hq bot commented Aug 5, 2025

CodSpeed Performance Report

Merging #32857 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

fix(kit): resolve to directories in `resolvePath` too and normalize file extensions #32857

fix(kit): resolve to directories in `resolvePath` too and normalize file extensions #32857

cernymatej commented Aug 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)