FOR EXPERIMENTAL.
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.
Includes vue-router and Pinia 1.
In addition, ESLint, Stylelint, and Prettier are also included and are set to be executed automatically at runtime and commit. (Since these settings are set strictly, please relax yourself.)
Also, when the development server is executed, it is checked in real time by vite-plugin-checker.
VSCode + Volar (and disable Vetur).
| Command | Description |
|---|---|
| dev | Start devserver. |
| clean | Clear devserver cache. |
| lint | Run ESLint and prettier. |
| lint:style | Run Stylelint. |
| lint:markup | Check vue markup. |
| build | Build for production. |
| build:analyze | Execute Bundle Analyzer |
| build:deploy | Build for production without checking. |
| build:clean | Clear production build files. |
| preview | Run the program generated by the production build. |
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.
When adding or deleting files, an error may occur and even if the error is corrected, it may not be reflected in devserver. In that case, stop devserver and delete all the files in the node_modules/.vite directory. You can also run it with the clean command.
Footnotes
-
Pinia is the recommended state management library to replace Vuex in the next Vue. see https://github.com/vuejs/rfcs/discussions/270#discussioncomment-2066856 ↩