docs: add tip for when using auto imports

[HanKruiger]

🔗 Linked issue

❓ 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

To streamline on-boarding when using the official Vue.js starter, I added a tip to the docs to prevent others from encountering an issue that I tackled recently.

The problem I encountered was:

• Vue.js official starter uses run-p type-check \"build-only {@}\" -- as the build step. This builds the application in parallel with type-checking.
• That sounds nice, but the type declaration files that unplugin-auto-import generates are only generated in the build-only script, so when building in a fresh environment, type checking fails.
• I resolved it by replacing run-p type-check \"build-only {@}\" -- with run-s \"build-only {@}\" type-check --.

📝 Checklist

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

[pkg-pr-new]

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

commit: 1a5c19c

[benjamincanac]

I'm not sure about this, I would just move the typecheck to a different command: https://github.com/nuxt-ui-pro/starter-vue/blob/main/package.json#L7

[HanKruiger]

That makes sense as well! Then you'd need to make sure to run it in your CI though, to guarantee type safety in the code you ship.

I do feel like the documentation should at least accommodate the path from the official Vue.js starter a bit clearer though!

But feel free to close / change this PR. 😊