Run & review this pull request in StackBlitz Codeflow.

Walkthrough

• Added an optional declarationPath?: string to the Component interface in packages/schema/src/types/components.ts to record a component declaration file path.
• Updated resolveComponentTypes in packages/nuxt/src/components/templates.ts to use a local componentPath = c.declarationPath || c.filePath when constructing the typeof import type hint, replacing prior direct use of c.filePath.
• Documentation updated to document declarationPath on AddComponentOptions in docs/3.api/5.kit/5.components.md.
• No exported/public function signatures were otherwise changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

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.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Open in StackBlitz

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

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

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

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

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

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

commit: 58cd078

CodSpeed Performance Report

Merging #33380 will not alter performance

_{Comparing 8ctavio:feat-1 (58cd078) with main (011c13e)}

Summary

✅ 10 untouched

my apologies @8ctavio - I merged a duplicate PR not realising it wasn't yours (#33419).

I'll be merging this one as well though 🙏❤️

@danielroe don't worry 👍. Thank you.

About the other PR though, I see that it added declarationPath support for scanning dirs with addComponentsDirs as well, but I'm not sure the expected behavior is implemented:

This line assigns dir.declarationPath to a component's declarationPath if present; I think there are two problems with this:

1. For consistency, I suppose ScanDir.declarationPath should be a directory path, but Component.declarationPath expects a file path.
2. If dir.declarationPath is a file path, all scanned components would try to get their declaration from dir.declarationPath, which is not invalid, but it seems that the default behavior should rather be to join dir.declarationPath with found file names on dir.path:

- declarationPath: dir.declarationPath || filePath,
+ declarationPath: join(dir.declarationPath, _file) || filePath

If dir.declarationPath as a file path should be supported, it could be checked whether dir.declarationPath is a file or directory, but ensure Component.declarationFile is a file path (or is not defined).

However, I have not encountered specific use cases for addComponentsDirs, so I can't say for sure that dir.declarationPath as a directory path is prefered.

you make a good point. we should probably not support it for component dirs directly.