526互联

企业级项目模板的配置与集成（Vite + Vue3 + TypeScript）

发布时间 2023-05-17 12:34:36作者: 笔下洛璃

企业级项目模板的配置与集成（Vite + Vue3 + TypeScript）

1、项目介绍

项目使用：eslint + stylelint + prettier来对我们代码质量做检测和修复。

需要使用husky来做commit拦截

需要使用commitlint来统一提交规范

需要使用preinstall来统一包管理工具。

2、环境准备

  • node v16.14.2
  • pnpm 8.0.0（因为懒得安装新版的node，以下我使用npm进行管理）

3、初始化项目

本项目使用Vite进行构建。

pnpm：performant npm，意思是高性能的npm，解决了npm/yarn内部潜在的bug，极大地优化了性能，被誉为“最先进的包管理工具”

npm i -g pnpm

4、项目配置

4.1、eslint配置

这个插件的目标是提供一个插件化的JS代码检测工具，TS作为JS的超集，自然也可以检测。

npm i eslint -D

生成配置文件：.eslint.cjs

npx eslint --init

4.2、Vue3环境代码校验插件

安装：

npm install -D eslint-plugin-import eslint-plugin-vue eslint-plugin-node eslint-plugin-prettier eslint-config-prettier eslint-plugin-node @babel/eslint-parser

修改一下.eslint.cjs

module.exports = {
    "env": {
        "browser": true,
        "es2021": true
    },
    "extends": [
        "eslint:recommended",
        "plugin:vue/vue3-essential",
        "plugin:@typescript-eslint/recommended"
    ],
    "overrides": [
    ],
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "ecmaVersion": "latest",
        "sourceType": "module"
    },
    "plugins": [
        "vue",
        "@typescript-eslint"
    ],
    "rules": {
        // eslint（https://eslint.bootcss.com/docs/rules/）
        'no-var': 'error', // 要求使用let 或 const，禁止var
        'no-multiple-empty-lines': ["warn", { max: 1}], // 不允许多个空行
        'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
        'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
        'no-unexpected-multiline': 'error', // 禁止多余空行
        'no-useless-escape': 'off', // 禁止不必要的转义字符

        // typescript（https://typescript-eslint.io/rules）
        '@typescript-eslint/no-unused-vars': 'error', // 禁止定义未使用的变量
        '@typescript-eslint/prefer-ts-expect-error': 'error', // 禁止使用 @ts-ignore
        '@typescript-eslint/no-explicit-any': 'off', // 禁止使用any
        '@typescript-eslint/no-non-null-assertion': 'off',
        '@typescript-eslint/no-namespace': 'off', // 禁止使用自定义TypeScript模块
        '@typescript-eslint/semi': 'off',

        // eslint-plugin-vue（https://eslint.vuejs.org/rules/）
        'vue/multi-word-component-names': 'off', // 要求组件名称始终为“-”链接的单词
        'vue/script-setup-uses-vars': 'error', // 防止<script setup>使用的变量<template>
        'vue/no-mutating-props': 'off', // 不允许组件prop的改变
        'vue/attribute-hyphenation': 'off', // 对模板中的自定义组件强制执行属性命令样式
    }
}

创建.eslintignore忽略文件

dist
node_modules

package.json新增两个脚本：

"scripts": {
  "lint": "eslint src",
  "fix": "eslint src --fix"
},

4.3、prettier配置

有了eslint，为什么还要有prettier？

eslint是针对JS，在eslint看来，语法对了，代码就能正常运行，格式问题属于其次。

而prettier属于格式化工具，它看不惯格式不统一，所以它就把eslint没干好的事情接着干。另外，prettier支持JS在内的多种语言。

安装：

npm i -D eslint-plugin-prettier prettier eslint-config-prettier

prettierrc.json添加规则：

{
    "singleQuote": true, // 字符串都是单引号
    "semi": false, // 不要分号
    "bracketSpacing": true,
    "htmlWhitespaceSensitivity": "ignore",
    "endOfLine": "auto",
    "trailingComma": "all",
    "tabWidth": 2 // 两个缩进
}

.prettierignore忽略文件

/dist/*
/html/*
.local
/node_modules/**
**/*.svg
**/*.sh
/public/*

4.4、stylelint

stylelint为css的lint工具，可以格式化css代码，检查css语法错误和不合理的写法，指定css书写顺序等。

项目中使用scss作为预处理器，安装以下依赖：

npm add sass sass-loader stylelint postcss postcss-scss postcss-html stylelint-config-prettier stylelint-config-recess-order stylelint-config-recommended-scss stylelint-config-standard stylelint-config-standard-vue stylelint-scss stylelint-order stylelint-config-standard-scss -D

.stylelintrc.cjs配置文件：

// @see https://stylelint.bootcss.com/
module.exports = {
    extends: [
      'stylelint-config-standard', // 配置stylelint拓展插件
      'stylelint-config-html/vue', // 配置 vue 中 template 样式格式化
      'stylelint-config-standard-scss', // 配置stylelint scss插件
      'stylelint-config-recommended-vue/scss', // 配置 vue 中 scss 样式格式化
      'stylelint-config-recess-order', // 配置stylelint css属性书写顺序插件,
      'stylelint-config-prettier', // 配置stylelint和prettier兼容
    ],
    overrides: [
      {
        files: ['**/*.(scss|css|vue|html)'],
        customSyntax: 'postcss-scss',
      },
      {
        files: ['**/*.(html|vue)'],
        customSyntax: 'postcss-html',
      },
    ],
    ignoreFiles: [
      '**/*.js',
      '**/*.jsx',
      '**/*.tsx',
      '**/*.ts',
      '**/*.json',
      '**/*.md',
      '**/*.yaml',
    ],
    /**
     * null  => 关闭该规则
     * always => 必须
     */
    rules: {
      'value-keyword-case': null, // 在 css 中使用 v-bind，不报错
      'no-descending-specificity': null, // 禁止在具有较高优先级的选择器后出现被其覆盖的较低优先级的选择器
      'function-url-quotes': 'always', // 要求或禁止 URL 的引号 "always(必须加上引号)"|"never(没有引号)"
      'no-empty-source': null, // 关闭禁止空源码
      'selector-class-pattern': null, // 关闭强制选择器类名的格式
      'property-no-unknown': null, // 禁止未知的属性(true 为不允许)
      'block-opening-brace-space-before': 'always', //大括号之前必须有一个空格或不能有空白符
      'value-no-vendor-prefix': null, // 关闭 属性值前缀 --webkit-box
      'property-no-vendor-prefix': null, // 关闭 属性前缀 -webkit-mask
      'selector-pseudo-class-no-unknown': [
        // 不允许未知的选择器
        true,
        {
          ignorePseudoClasses: ['global', 'v-deep', 'deep'], // 忽略属性，修改element默认样式的时候能使用到
        },
      ],
    },
  }

详见官网：https://stylelint.bootcss.com/

脚本添加：

"scripts": {
    "format": "prettier --write \"./**/*.{html,vue,ts,js,json,md}\"",
    "lint:eslint": "eslint src/**/*.{ts,vue} --cache --fix",
    "lint:style": "stylelint src/**/*.{css,scss,vue} --cache --fix"
}

最后当我们npm run format的时候，代码就会格式化。

4.5、husky配置

上面已经配置好了代码校验工具，但是要手动执行命令才会格式化我们的代码。如果没有格式化就提交到远程仓库的话，那这个规范就没有什么用了。因此我们要强制让开发人员按照规范来提交代码。

要做到这件事就需要使用husky，在代码提交之前 触发githook，然后执行npm run format来格式化代码。

安装husky：

npm i -D husky

执行：

npx husky-init

会在根目录下生成一个.husky目录，这个目录下有一个pre-commit文件，在这个文件中里的命令会在commit之前触发。

在.husky/pre-commit文件添加如下命令：

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
pnpm run format

当我们对代码进行commit操作的时候，就会执行命令，对代码进行格式化，然后再提交。

4.6、配置commitLint

对于我们的commit信息，也是有统一规范的，不能随便写,要让每个人都按照统一的标准来执行，我们可以利用commitlint来实现。

安装包：

npm add @commitlint/config-conventional @commitlint/cli -D

添加配置文件，新建commitlint.config.cjs(注意是cjs)，然后添加下面的代码：

module.exports = {
  extends: ['@commitlint/config-conventional'],
  // 校验规则
  rules: {
    'type-enum': [
      2,
      'always',
      [
        'feat',
        'fix',
        'docs',
        'style',
        'refactor',
        'perf',
        'test',
        'chore',
        'revert',
        'build',
      ],
    ],
    'type-case': [0],
    'type-empty': [0],
    'scope-empty': [0],
    'scope-case': [0],
    'subject-full-stop': [0, 'never'],
    'subject-case': [0, 'never'],
    'header-max-length': [0, 'always', 72],
  },
}

在package.json中配置scripts命令：

{
"scripts": {
    "commitlint": "commitlint --config commitlint.config.cjs -e -V"
  },
}

配置结束，现在当我们填写commit信息的时候，前面就需要带着下面的subject

'feat',//新特性、新功能
'fix',//修改bug
'docs',//文档修改
'style',//代码格式修改, 注意不是 css 修改
'refactor',//代码重构
'perf',//优化相关，比如提升性能、体验
'test',//测试用例修改
'chore',//其他修改, 比如改变构建流程、或者增加依赖库、工具等
'revert',//回滚到上一个版本
'build',//编译相关的修改，例如发布版本、对项目构建或者依赖的改动

配置husky

npx husky add .husky/commit-msg

在生成的commit-msg文件中添加下面的命令

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
pnpm commitlint

当我们 commit 提交信息时，就不能再随意写了，必须是 git commit -m 'fix: xxx' 符合类型的才可以，需要注意的是类型的后面需要用英文的 :，并且冒号后面是需要空一格的，这个是不能省略的

4.7、强制使用pnpm包管理工具

团队开发项目的时候，需要统一包管理器工具,因为不同包管理器工具下载同一个依赖,可能版本不一样,

导致项目出现bug问题,因此包管理器工具需要统一管理！！！

在根目录创建scritps/preinstall.js文件，添加下面的内容

if (!/pnpm/.test(process.env.npm_execpath || '')) {
  console.warn(
    `\u001b[33mThis repository must using pnpm as the package manager ` +
    ` for scripts to work properly.\u001b[39m\n`,
  )
  process.exit(1)
}

配置命令

"scripts": {
    "preinstall": "node ./scripts/preinstall.js"
}

当我们使用npm或者yarn来安装包的时候，就会报错了。原理就是在install的时候会触发preinstall（npm提供的生命周期钩子）这个文件里面的代码。

5、项目集成

5.1、集成element-plus

npm install element-plus @element-plus/icons-vue

入口文件main.ts全局安装element-plus,element-plus默认支持语言英语设置为中文

import { createApp } from "vue";
import "./style.css";
import App from "./App.vue";
// 引入element-plus插件与样式
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
// 配置element-plus国际化
// @ts-ignore,让ts忽略mjs的类型检测
import zhCn from 'element-plus/dist/locale/zh-cn.mjs'
// 获取应用实例对象
const app = createApp(App);

app.use(ElementPlus, {
    locale: zhCn
})
// 挂载
app.mount("#app")

Element Plus全局组件类型声明

// tsconfig.json
{
  "compilerOptions": {
    // ...
    "types": ["element-plus/global"]
  }
}

配置完毕可以测试element-plus组件与图标的使用。

5.2、给src配置别名

// vite.config.ts
import {defineConfig} from 'vite'
import vue from '@vitejs/plugin-vue'
import path from 'path'
export default defineConfig({
    plugins: [vue()],
    resolve: {
        alias: {
            "@": path.resolve("./src") // 相对路径别名配置，使用 @ 代替 src
        }
    }
})

TypeScript 编译配置

// tsconfig.json
{
  "compilerOptions": {
    "baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录
    "paths": { //路径映射，相对于baseUrl
      "@/*": ["src/*"] 
    }
  }
}

5.3、环境变量的配置

项目开发过程中，至少会经历开发环境、测试环境和生产环境(即正式环境)三个阶段。不同阶段请求的状态(如接口地址等)不尽相同，若手动切换接口地址是相当繁琐且易出错的。于是环境变量配置的需求就应运而生，我们只需做简单的配置，把环境状态切换的工作交给代码。

  • 开发环境
    • 顾名思义，开发使用的环境，每位开发人员在自己的dev分支上干活，开发到一定程度，同事会合并代码，进行联调。
  • 测试环境
    • 测试同事干活的环境啦，一般会由测试同事自己来部署，然后在此环境进行测试
  • 生产环境
    • 生产环境是指正式提供对外服务的，一般会关掉错误报告，打开错误日志。(正式提供给客户使用的环境。)

注意：一般情况下，一个环境对应一台服务器，也有的公司开发与测试环境是一台服务器！！！

项目根目录分别添加 开发、生产和测试环境的文件!

.env.development
.env.production
.env.test

文件内容

# 变量必须以 VITE_ 为前缀才能暴露给外部读取
NODE_ENV = 'development'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/dev-api'

NODE_ENV = 'production'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/prod-api'

NODE_ENV = 'test'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/test-api'

配置运行命令：package.json

"scripts": {
  "dev": "vite --open",
  "build:test": "vue-tsc && vite build --mode test",
  "build:pro": "vue-tsc && vite build --mode production",
  "preview": "vite preview"
},

通过import.meta.env获取环境变量。

5.4、SVG图标配置

在开发项目的时候经常会用到svg矢量图，而且我们使用SVG以后，页面上加载的不再是图片资源。

这对页面性能来说是个很大的提升，而且我们SVG文件比img要小的很多，放在项目中几乎不占用资源。

安装SVG依赖插件：

npm install vite-plugin-svg-icons -D

在vite.config.ts中配置插件

import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
import path from 'path'
export default () => {
  return {
    plugins: [
      createSvgIconsPlugin({
        // Specify the icon folder to be cached
        iconDirs: [path.resolve(process.cwd(), 'src/assets/icons')],
        // Specify symbolId format
        symbolId: 'icon-[dir]-[name]',
      }),
    ],
  }
}

入口文件导入


使用：

比如aliicon图标库，在src/assets创建一个icons文件夹，然后下面创建比如phone.svg，把图标库的svg代码点击复制，粘贴保存。

然后在组件中使用：

<!--svg必须与use结合使用-->
<svg style="width:30px;height:30px;">
  <!--xlink:href执行用哪一个图标，属性值务必#icon-图标名字-->
  <!--fill属性可以设置图标的颜色-->
  <use xlink:href="#icon-phone" fill="yellow"></use>
</svg>

可以封装成一个组件components/SvgIcon/index.vue

<template>
    <svg :style="{width, height}">
        <use :xlink:href="prefix + name" :fill="color"></use>
    </svg>
</template>

<script setup lang="ts">
    import { defineProps } from 'vue';
    // 接受父组件传递过来的参数
    defineProps({
        // xlink:href属性值前缀
        prefix: {
            type: String,
            default: '#icon-'
        },
        // 提供使用图标的名字
        name: String,
        // 接受父组件传递过来的颜色
        color: {
            type: String,
            default: '',
        },
        // 接受父组件传过来的图标的宽度
        width: {
            type: String,
            default: '16px'
        },
        // 高度
        height: {
            type: String,
            default: '16px'
        }
    });
</script>

注册全局组件：

因为这个svg图标，在很多组件里面都会用到，为了避免每个用到它的组件都要import，所以把它注册成全局组件。

在入口文件中：

import SvgIcon from '@/components/SvgIcon/index.vue'
app.component('SvgIcon', SvgIcon)

更好的注册全局组件的方式

在components文件夹下创建index.ts，用来统一暴露全局组件，因为以后会有很多全局组件，在这个文件里统一管理比较方便。

components/index.ts

// 引入项目中全部的全局组件
import SvgIcon from '@/components/SvgIcon/index.vue'
import { keysOf } from 'element-plus/es/utils/objects.js';

// 全局对象
const allGlobalComponent = { SvgIcon }

// 对外暴露插件对象
export default {
    install(app) {
        // 注册项目全部的全局组件
        Object.keys(allGlobalComponent).forEach(key => {
            app.component(key, allGlobalComponent[key])
        });
    }
}

入口文件main.ts：

// 引入自定义插件对象：注册整个项目的全局组件
import globalComponent from '@/components'
app.use(globalComponent)

5.5、集成scss

我们目前在组件内部已经可以使用scss样式,因为在配置styleLint工具的时候，项目当中已经安装过sass sass-loader,因此我们再组件内可以使用scss语法！！！需要加上lang="scss"

<style scoped lang="scss"></style>

接下来我们为项目添加一些全局的样式

在src/styles目录下创建三个文件：

  • index.scss
    • 全局样式文件
  • reset.scss
    • 清除默认样式，去npm官方搜索复制粘贴
  • variable.scc
    • 定义全局变量

当然项目中需要用到清除默认样式，因此在index.scss引入reset.scss

@import reset.scss

在入口文件：

import '@/styles'

但是你会发现在src/styles/index.scss全局样式文件中没有办法使用$变量，因此需要给项目中引入全局变量$

在styles下创建一个variable.scss文件！

在vite.config.ts文件配置如下:

export default defineConfig((config) => {
      css: {
        preprocessorOptions: {
          scss: {
            javascriptEnabled: true,
            additionalData: '@import "./src/styles/variable.scss";',
          },
        },
      },
    }
}

@import "./src/styles/variable.scss";后面的;不要忘记，不然会报错!

配置完毕你会发现scss提供这些全局变量可以在组件样式中使用了！！！

5.6、mock数据

npm install -D vite-plugin-mock@2 mockjs（踩坑，自动安装的vite-plugin-mock，版本是3，而这里需要2）

在vite.config.js配置文件中启动插件：

import { viteMockServe } from 'vite-plugin-mock'
import vue from '@vitejs/plugin-vue'
export default ({ command })=> {
  return {
    plugins: [
      vue(),
      viteMockServe({
        localEnabled: command === 'serve',
      }),
    ],
  }
}

在根目录mock文件夹下，去创建我们需要的mock数据与接口！！！

在mock文件夹内部创建一个user.ts文件：

//用户信息数据
function createUserList() {
    return [
        {
            userId: 1,
            avatar:
                'https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif',
            username: 'admin',
            password: '111111',
            desc: '平台管理员',
            roles: ['平台管理员'],
            buttons: ['cuser.detail'],
            routes: ['home'],
            token: 'Admin Token',
        },
        {
            userId: 2,
            avatar:
                'https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif',
            username: 'system',
            password: '111111',
            desc: '系统管理员',
            roles: ['系统管理员'],
            buttons: ['cuser.detail', 'cuser.user'],
            routes: ['home'],
            token: 'System Token',
        },
    ]
}

export default [
    // 用户登录接口
    {
        url: '/api/user/login',//请求地址
        method: 'post',//请求方式
        response: ({ body }) => {
            //获取请求体携带过来的用户名与密码
            const { username, password } = body;
            //调用获取用户信息函数,用于判断是否有此用户
            const checkUser = createUserList().find(
                (item) => item.username === username && item.password === password,
            )
            //没有用户返回失败信息
            if (!checkUser) {
                return { code: 201, data: { message: '账号或者密码不正确' } }
            }
            //如果有返回成功信息
            const { token } = checkUser
            return { code: 200, data: { token } }
        },
    },
    // 获取用户信息
    {
        url: '/api/user/info',
        method: 'get',
        response: (request) => {
            //获取请求头携带token
            const token = request.headers.token;
            //查看用户信息是否包含有次token用户
            const checkUser = createUserList().find((item) => item.token === token)
            //没有返回失败的信息
            if (!checkUser) {
                return { code: 201, data: { message: '获取用户信息失败' } }
            }
            //如果有返回成功信息
            return { code: 200, data: {checkUser} }
        },
    },
]

安装axios，在main.ts中进行接口测试：

npm install axios

// 测试代码
import axios from "axios";

axios({
    url: '/api/user/login',
    method: "post",
    data: {
        username: 'admin',
        password: '111111'
    }
});

5.7、axios二次封装

在开发项目的时候避免不了与后端进行交互,因此我们需要使用axios插件实现发送网络请求。在开发项目的时候我们经常会把axios进行二次封装。

目的:

  • 使用请求拦截器，可以在请求拦截器中处理一些业务(开始进度条、请求头携带公共参数)
  • 使用响应拦截器，可以在响应拦截器中处理一些业务(进度条结束、简化服务器返回的数据、处理http网络错误)

在根目录下创建utils/request.ts

import axios from "axios";
import { ElMessage } from "element-plus";
//创建axios实例
let request = axios.create({
    baseURL: import.meta.env.VITE_APP_BASE_API,
    timeout: 5000
})
//请求拦截器
request.interceptors.request.use(config => {
    return config;
});
//响应拦截器
request.interceptors.response.use((response) => {
    return response.data;
}, (error) => {
    //处理网络错误
    let msg = '';
    let status = error.response.status;
    switch (status) {
        case 401:
            msg = "token过期";
            break;
        case 403:
            msg = '无权访问';
            break;
        case 404:
            msg = "请求地址错误";
            break;
        case 500:
            msg = "服务器出现问题";
            break;
        default:
            msg = "无网络";

    }
    ElMessage({
        type: 'error',
        message: msg
    })
    return Promise.reject(error);
});
export default request;

5.8、API接口统一管理

在开发项目的时候,接口可能很多需要统一管理。在src目录下去创建api文件夹去统一管理项目的接口；

比如用户相关的接口，就在api文件夹下，创建一个user文件夹，统一管理。

  • api/user/type.ts
    • 定义ts数据类型
  • api/user/index.ts
    • 写接口

——

api/user/type.ts（用于定义ts数据类型）

// 定义用户相关数据的ts类型
// 登录接口需要携带参数ts的类型
export interface loginForm {
    username: string,
    password: string
}

// 定义全部接口返回数据都拥有ts类型
export interface ResponseData {
    code: number
    message: string
    ok: boolean
  }

// 登录接口返回的数据类型
export interface loginResponseData extends ResponseData {
    data: string
  }

// 定义服务器返回用户信息相关的数据类型
export interface userInfoReponseData extends ResponseData {
    data: {
      routes: string[]
      buttons: string[]
      roles: string[]
      name: string
      avatar: string
    }
  }

api/user/index.ts（用于定义接口）

// 统一管理项目用户相关的接口
import request from "@/utils/request"
import type {
    loginFormData,
    loginResponseData,
    userInfoReponseData,
  } from './type'

// 项目用户相关的请求地址
enum API {
    LOGIN_URL = '/admin/acl/index/login',
    USERINFO_URL = '/admin/acl/index/info',
    LOGOUT_URL = '/admin/acl/index/logout',
}

//登录接口
export const reqLogin = (data: loginFormData) =>
  request.post<any, loginResponseData>(API.LOGIN_URL, data)

//获取用户信息
export const reqUserInfo = () =>
  request.get<any, userInfoReponseData>(API.USERINFO_URL)
  
//退出登录
export const reqLogout = () => request.post<any, any>(API.LOGOUT_URL)

6、随笔总结自