前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >一套规范的vue3+vite2+ts4前端工程化项目环境

一套规范的vue3+vite2+ts4前端工程化项目环境

作者头像
达达前端
发布2022-04-29 10:53:47
5190
发布2022-04-29 10:53:47
举报
文章被收录于专栏:达达前端达达前端

一套规范的vue3+vite2+ts4前端工程化项目环境 webvueblog.github.io/vue3-vite2-…

Vue 3 + Typescript + Vite

vue3-vite2-ts4

代码语言:javascript
复制
npm init @vitejs/app
vue
vue-ts
npm install
npm run dev
复制代码
758be7391e9db20f54ef8b8c947ecd2c.png
758be7391e9db20f54ef8b8c947ecd2c.png

目录结构如下

代码语言:javascript
复制
├── public              静态资源
├── src
│   ├── assets           资源目录(图片、less、css等)
│   ├── components       项目组件
│   ├── App.vue          主应用
│   ├── env.d.ts         全局声明
│   └── main.ts          主入口
├── .gitignore           git忽略配置
├── index.html           模板文件
├── package.json        依赖包/运行脚本配置文件
├── README.md
├── tsconfig.json        ts配置文件
├── tsconfig.node.json   ts配置文件
└── vite.config.ts       vite配置
复制代码

每个目录的作用后文都会提及

代码语言:javascript
复制
├── src
│   ├── router           路由配置
│   ├── stores           状态管理
│   ├── typings          ts公共类型
│   ├── utils            工具类函数封装
│   └── views            页面视图
复制代码

指定解析路径使用的 path module需要先安装@type/node

代码语言:javascript
复制
npm install @types/node --save-dev
复制代码

打包功能

代码语言:javascript
复制
build: {
      outDir: 'dist',   // 指定打包路径,默认为项目根目录下的 dist 目录
      terserOptions: {
          compress: {
              keep_infinity: true,  // 防止 Infinity 被压缩成 1/0,这可能会导致 Chrome 上的性能问题
              drop_console: true,   // 生产环境去除 console
              drop_debugger: true   // 生产环境去除 debugger
          },
      },
      chunkSizeWarningLimit: 1500   // chunk 大小警告的限制(以 kbs 为单位)
}
复制代码

接入代码规范

ESlint 被称作下一代的 JS Linter 工具,能够将 JS 代码解析成 AST 抽象语法树,然后检测 AST 是否符合既定的规则。

代码语言:javascript
复制
yarn add eslint @typescript-eslint/parser @typescript/eslint-plugin eslint-plugin-vue
复制代码

TypeScirpt 官方决定全面采用 ESLint 作为代码检查的工具,并创建了一个新项目 typescript-eslint,提供了 TypeScript 文件的解析器 @typescript-eslint/parser 和相关的配置选项 @typescript-eslint/eslint-plugin 等

使用 scss 来增强 css 的语法能力

代码语言:javascript
复制
yarn add sass
yarn add stylelint
yarn add stylelint-scss
复制代码

接入naive ui库

Naive UI 是尤大推荐的 vue3 UI 库(www.naiveui.com/zh-CN/os-th…)

接入 vue-router

代码语言:javascript
复制
npm install vue-router --save
复制代码
代码语言:javascript
复制
import {
    createRouter, createWebHashHistory, RouteRecordRaw,
} from 'vue-router'

const routes: Array<RouteRecordRaw> = [
    { path: '/', name: 'Home', component: () => import('views/home/index.vue')}
]

const router = createRouter({
    history: createWebHashHistory(),    // history 模式则使用 createWebHistory()
    routes,
})

export default router
复制代码
代码语言:javascript
复制
import { createApp } from 'vue'
import App from './App.vue'
import router from './router/index'

const app = createApp(App as any)
app.use(router)
复制代码

接入状态管理工具 pinia

pinia 是一个轻量级的状态管理库

代码语言:javascript
复制
npm install pinia --save
复制代码

引入

在 main.ts中引入

代码语言:javascript
复制
import { createPinia } from 'pinia'

app.use(createPinia())
复制代码

在src/stores下新建一个counters.ts文件

代码语言:javascript
复制
import { defineStore } from 'pinia'

export const useCounterStore = defineStore('counter', {
    state: () => {
        return {
            count: 0
        }
    },
    getters: {
        count() {
            return this.count
        }
    },
    actions: {
        increment() {
            this.count++
        }
    }
})
复制代码
代码语言:javascript
复制
import { defineStore } from 'pinia'

export const useCounterStore = defineStore('counter', () => {
    const count = ref(0)
    function increment() {
      count.value++
    }

    return { count, increment }
})
复制代码
代码语言:javascript
复制
<script lang="ts" setup>
    import { useCounterStore } from '@/stores/counter'

    const counter = useCounterStore()
</script>
<template>
    <div @click="counter.increment()">
        {{ counter.count }}
    </div>
</template>
复制代码
代码语言:javascript
复制
const counter = useCounterStore()
const { count } = counter

<div @click="counter.increment()">{{ count }}</div>
复制代码

pinia很贴心的提供了storeToRefs方法,让我们可以享受解构的乐趣:

代码语言:javascript
复制
const { count } = storeToRefs(counter)
复制代码

接入图表库 echarts5

安装&引入

代码语言:javascript
复制
npm install echarts --save
复制代码

在src/utils/下新建echarts.ts用来引入我们需要使用的组件

代码语言:javascript
复制
import * as echarts from 'echarts/core'
import {
    BarChart,
    // 系列类型的定义后缀都为 SeriesOption
    BarSeriesOption,
    // LineChart,
    LineSeriesOption
} from 'echarts/charts'
import {
    TitleComponent,
    // 组件类型的定义后缀都为 ComponentOption
    TitleComponentOption,
    TooltipComponent,
    TooltipComponentOption,
    GridComponent,
    GridComponentOption,
    // 数据集组件
    DatasetComponent,
    DatasetComponentOption,
    // 内置数据转换器组件 (filter, sort)
    TransformComponent,
    LegendComponent
} from 'echarts/components'
import { LabelLayout, UniversalTransition } from 'echarts/features'
import { CanvasRenderer } from 'echarts/renderers'

// 通过 ComposeOption 来组合出一个只有必须组件和图表的 Option 类型
export type ECOption = echarts.ComposeOption<
    | BarSeriesOption
    | LineSeriesOption
    | TitleComponentOption
    | TooltipComponentOption
    | GridComponentOption
    | DatasetComponentOption
>

// 注册必须的组件
echarts.use([
    TitleComponent,
    TooltipComponent,
    GridComponent,
    DatasetComponent,
    TransformComponent,
    BarChart,
    LabelLayout,
    UniversalTransition,
    CanvasRenderer,
    LegendComponent
])

// eslint-disable-next-line no-unused-vars
const option: ECOption = {
    // ...
}

export const $echarts = echarts
复制代码

就可以在页面中使用了:

代码语言:javascript
复制
<script lang="ts" setup>
    import { onMounted } from 'vue'
    import { $echarts, ECOption } from '@/utils/echarts'

    onMounted(() => {
        // 测试echarts的引入
        const ele = document.getElementById('echarts') as HTMLCanvasElement
        const myChart = $echarts.init(ele)
        const option: ECOption = {
            title: {
                text: 'ECharts 入门示例'
            },
            tooltip: {},
            legend: {
                data: ['销量']
            },
            xAxis: {
                data: ['衬衫', '羊毛衫', '雪纺衫', '裤子', '高跟鞋', '袜子']
            },
            yAxis: {},
            series: [
                {
                    name: '销量',
                    type: 'bar',
                    data: [5, 20, 36, 10, 10, 20]
                }
            ]
        }     
</script>
复制代码

配置统一 axios 处理

安装&引入

代码语言:javascript
复制
npm install axios --save
复制代码

截图:

ffb79dd5fd7be2d4f5a35b848d3059e4.png
ffb79dd5fd7be2d4f5a35b848d3059e4.png
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2022-04-17,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Vue 3 + Typescript + Vite
    • 接入代码规范
      • 使用 scss 来增强 css 的语法能力
        • 接入naive ui库
          • 接入 vue-router
            • 接入状态管理工具 pinia
              • 接入图表库 echarts5
                • 配置统一 axios 处理
                相关产品与服务
                腾讯云代码分析
                腾讯云代码分析(内部代号CodeDog)是集众多代码分析工具的云原生、分布式、高性能的代码综合分析跟踪管理平台,其主要功能是持续跟踪分析代码,观测项目代码质量,支撑团队传承代码文化。
                领券
                问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档