/vue-awesome-template

☀Opinionated Vue3 Starter Template

Primary LanguageTypeScriptMIT LicenseMIT

vue-awesome-template

💥 Important!!! The old template cli-2.x and cli@4.x are archived,please check the guide below.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

TODO

  • 约束镜像源和npm、node、pnpm版本
  • 仅允许使用pnpm
  • Eslint + prettier ready
  • vite配置拆分
  • 集成tailwindcss
  • 构建gzip
  • 多构建环境区分
  • 目录分层
  • TS支持
  • html支持env变量
  • 支持三方包拆分到独自的chunk中
  • 主题化
  • svg 集成
  • vueuse集成
  • TSX支持
  • Vue3API自动导入支持
  • 深色模式支持
  • Inspect调试支持
  • 组件模板生成/移除
  • i18n支持
  • 支持event-bus（基于EventEmitter3）
  • 自定义import语句顺序
  • 支持CI构建，可通过pnpm build:prod -- --ciVersion 1.1.1添加构建版本号
  • swagger转ts类型文件并自动生成request文件