/vue3-vite-template

The starter developed base on vue3 and ant-design-vue. This template should help get you started developing with Vue 3 and Typescript in Vite.

Primary LanguageTypeScriptMIT LicenseMIT

Vue3 + Vite2 + Typescript

vue3 ant-desigin-vue vuex MIT license

Simplified Chinese | English

The starter developed base on vue3 and ant-design-vue. This template should help get you started developing with Vue 3 and Typescript in Vite.

Feature

  • plugin：build/vite/plugin
  • proxy：build/vite/proxy
  • UT：tests
  • mock：mock
  • entry：src/main
  • router：src/router
  • store：src/store
  • views：src/views
  • hook：src/hook
  • components：src/components
  • utils：src/common, src/utils
  • globalization：src/language
  • support jsx & tsx, and script setup

Quick Start

yarn
yarn serve

Recommended IDE Setup

VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService in settings!

If Using <script setup>

<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).

Type Support For .vue Imports in TS

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

  1. Install and add @vuedx/typescript-plugin-vue to the plugins section in tsconfig.json
  2. Delete src/shims-vue.d.ts as it is no longer needed to provide module info to Typescript
  3. Open src/main.ts in VSCode
  4. Open the VSCode command palette
  5. Search and run "Select TypeScript version" -> "Use workspace version"

Licenses

MIT