vue-tsc (Volar)
You can use vue-tsc checker for your Vue3 project. If you're still using Vue2, choose VLS checker.
Installation
Make sure vue-tsc & typescript are installed as a peer dependency of your Vite project.
bashpnpm add vue-tsc@latest typescript -D
TIP
The
vue-tsc
version must be >=0.33.9
.vue-tsc
has released a1.0.0
version, it's recommended to try it out.Add
vueTsc
field to plugin config.jsexport default { plugins: [checker({ vueTsc: true /** or an object config */ })], }
Configuration
Advanced object configuration table of options.vueTsc
field | Type | Default value | Description |
---|---|---|---|
root | string | Vite config root | Root path to find tsconfig file |
tsconfigPath | string | "tsconfig.json" | Relative tsconfig path to root |
- (optional for Vue2 project only) The type check is powered by
vue-tsc
so it supports Vue2. According to the documentation, you need to install@vue/runtime-dom
for Vue version <=2.6.14
.