返回

工欲善其事,必先利其器:打造一个 Vue3 + TypeScript 项目模板

前端

在软件开发中,有一个至关重要的原则:工欲善其事,必先利其器。对于 Vue.js 开发人员而言,拥有一个精心配置的项目模板至关重要,可以节省时间、减少重复性任务,并确保项目的一致性和可维护性。

本教程将引导你一步步配置一个全面的 Vue3 + TypeScript 项目模板,集成了 vue-router、pinia、ant-design-vue、vue-i18n 和 vite 等强大库,为构建复杂的 Web 应用程序奠定坚实的基础。

项目配置

  1. 初始化项目

    使用 Vue CLI(脚手架)创建一个新的 Vue3 项目:

    vue create my-vue3-project --preset typescript
    
  2. 安装依赖项

    安装 vue-router、pinia、ant-design-vue、vue-i18n 和 vite:

    npm install vue-router pinia ant-design-vue vue-i18n vite --save
    
  3. 配置 vue-router

    main.ts 中配置 vue-router:

    import { createRouter, createWebHistory } from 'vue-router'
    
    const router = createRouter({
      history: createWebHistory(),
      routes: [
        {
          path: '/',
          name: 'Home',
          component: () => import('./views/Home.vue')
        }
      ]
    })
    
    export default router
    
  4. 配置 pinia

    main.ts 中配置 pinia:

    import { createPinia } from 'pinia'
    
    const pinia = createPinia()
    
    export default pinia
    
  5. 配置 ant-design-vue

    main.ts 中配置 ant-design-vue:

    import { createApp } from 'vue'
    import Antd from 'ant-design-vue'
    import 'ant-design-vue/dist/antd.css'
    
    const app = createApp(App)
    app.use(Antd)
    
  6. 配置 vue-i18n

    main.ts 中配置 vue-i18n:

    import { createI18n } from 'vue-i18n'
    import en from 'ant-design-vue/lib/locale/en_US'
    import zh from 'ant-design-vue/lib/locale/zh_CN'
    
    const i18n = createI18n({
      locale: 'en',
      fallbackLocale: 'en',
      messages: {
        en,
        zh
      }
    })
    
    export default i18n
    
  7. 配置 vite

    vite.config.ts 中配置 vite:

    import { defineConfig } from 'vite'
    
    export default defineConfig({
      server: {
        proxy: {
          '/api': {
            target: 'http://localhost:3000',
            changeOrigin: true
          }
        }
      }
    })
    

自定义扩展

除了这些核心依赖项,你还可以根据项目需求添加自定义扩展,例如:

  • Axios :用于发起 HTTP 请求
  • Vuex :用于管理全局状态
  • Sass :用于编写样式
  • Eslint :用于代码检查

开始开发

配置好项目模板后,你就可以开始构建应用程序了。下面是一些建议:

  • 创建组件和模块,并将其组织到模块中。
  • 使用 vue-router 来管理页面导航。
  • 使用 pinia 来管理状态。
  • 使用 ant-design-vue 来构建用户界面。
  • 使用 vue-i18n 来实现多语言支持。
  • 使用 vite 来加速开发。

结论

通过配置这个全面的 Vue3 + TypeScript 项目模板,你已经为构建高质量应用程序奠定了坚实的基础。它集成了流行的库和工具,可以提高你的开发效率和应用程序的可维护性。现在,你可以专注于业务逻辑,而不必担心底层配置。拥抱这个模板,开启高效、无缝的 Vue.js 开发之旅!