This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 <script setup>
SFCs, check out the script setup docs to learn more.
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 enable Volar's .vue
type support plugin by running Volar: Switch TS Plugin on/off
from VSCode command palette.
npm run dev
run the project and start to code with hot-reloading.
npm run build
build for production
npm run serve
run the build locally
npm run test
run test with jest
npm run format
format the code with prettier
npm run prepare
add git hooks from .githooks
directory, this command also runs before npm install
.
pre-push
before pushing a branch: run test, format the code and do a new commit if code has changed after running prettier.