Add instructions for type-only imports #2432
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Problem
Because Vue uses isolatedModules, it is necessary to use type-only import syntax when importing types. Discovering the resolution for this edge case is difficult when first beginning to work with TypeScript and Vue/Vite.
This is easy to replicate by creating an app with
create-vue
and selectihg thetypescript
option. Then, export an interface from a.ts
file and import it and try to use it as a type in a component. When you runnpm run type-check
you will see the error. Here is a sample repo that duplicates the problem with a newcreate-vue
app: https://github.com/jmcooper/create-vue-ts-reproReproducing the Problem
See instructions above to repro from scratch. Or:
npm install
npm run type-check
Proposed Solution
Update the documentation as proposed to make it clear this is an expected behavior and how to resolve it.
Additional Information
Sample repo to replicate the problem: https://github.com/jmcooper/create-vue-ts-repro