feat(nuxt): allow generating metadata for nuxt components

[danielroe]

🔗 Linked issue

resolves #15015

❓ 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 like performance)
• ✨ 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

This adds a new option: components.generateMetadata which writes ~/.nuxt/components.json which could be consumed by other integrations to get information about the auto-imported components in your app.

The original use case of this (eslint) will likely be implemented differently so it may be worth reconsidering this and/or closing the PR. What do you think @antfu?

📝 Checklist

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

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[antfu]

If we end up recommending the eslint config generation approach (nuxt/eslint#332), where the module can directly grab the necessary data from module hooks, I guess we don't need core to support that - unless there would be other cases to consume those data

[pi0]

I think it makes sense only if we can make it opt-in and expandable for component extracted meta (similar to nuxt-component-meta).

The advantage of being in core is that there is a unified protocol (+ caching chance to avoid preparing same SFC multiple times) to augment and access component data and it is probably valuable.

[danielroe]

Yes, this is opt-in - it has be enabled with components.generateMeta.

Are you thinking we could support an additional field (meta?) on each component that could be populated?

[pi0]

additional meta object to be expandable with hooks sound a nice idea. Also for sure yes being opt-in makes sense.

[nuxt-studio]

✅ Live Preview ready!

Name	Edit	Preview	Latest Commit
Nuxt Docs	Edit on Studio ↗︎	View Live Preview	0a8d758