Vue 3 + Typescript + Vite
This template should help get you started developing with Vue 3 and Typescript in Vite.
New Project
run code
git init
remove .git/hooks
npx husky-init && yarn
replace .husky/pre-commit
last line
npx eslint --fix ./src --ext .vue,.js,.ts && git add .
Recommended IDE Setup
VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService
in settings!
<script setup>
If Using <script setup>
is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).
.vue
Imports in TS
Type Support For Since TypeScript cannot handle type information for .vue
imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue
imports (for example to get props validation when using manual h(...)
calls), you can use the following:
If Using Volar
Run Volar: Switch TS Plugin on/off
from VSCode command palette.
If Using Vetur
- Install and add
@vuedx/typescript-plugin-vue
to the plugins section intsconfig.json
- Delete
src/shims-vue.d.ts
as it is no longer needed to provide module info to Typescript - Open
src/main.ts
in VSCode - Open the VSCode command palette
- Search and run "Select TypeScript version" -> "Use workspace version"