feat(unplugin): add option to allow external packages to scan for components

[ISOR3X]

🔗 Linked issue

Resolves #4892

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Allows adding external packages to be scanned for Nuxt UI components through the new allowedPackages option. This allows using Nuxt UI as a dependency for other projects.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[ISOR3X]

I wasn't sure about the name or location for the option. Besides the current option, I also considered extending ComponentsOptions since feature mostly relates to unplugin-vue-components. In the end I decided against it to keep that key purely for the options from that package.

[pkg-pr-new]

npm i https://pkg.pr.new/@nuxt/ui@5510

commit: c0f8404

[benjamincanac]

I'm wondering if it wouldn't be easier to just remove this exclude, do you have a reproduction to try if it doesn't decrease performances?

[ISOR3X]

I'm wondering if it wouldn't be easier to just remove this exclude, do you have a reproduction to try if it doesn't decrease performances?

Wouldn't completely removing the exclude mean all node_module packages are scanned? I am not sure how unplugin-vue-components works, but I would expect that to take a lot longer than adding an option to scan a specific package.

[benjamincanac]

@romhml What do you think of this? Maybe we should remove the hard-coded @compodium/examples and document it inside compodium to use this option with Vite?

[romhml]

@benjamincanac Removing the ignore in unplugin-auto-import can't be good for build performances. You can remove @compodium/example for the defaults, although it will make its setup a bit more complex.

@ISOR3X how do you plan to leverage this in your projects? Edit Nuxt UI's plugin config inside yours or ask users to configure it themselves?

[ISOR3X]

@ISOR3X how do you plan to leverage this in your projects? Edit Nuxt UI's plugin config inside yours or ask users to configure it themselves?

The former. My main reason for this PR was mainly because we use Nuxt UI at the company I work at. Our UI library pretty much just wraps Nuxt UI and applies some different defaults and adds some extra components.