vue3+typescripy+vite项目初始化时的一些基本配置

1 初始化项目

# 安装pnpm
npm i -g pnpm

# 创建项目，根据提示输入项目名称
pnpm create vite

#√ Project name: ... ts-vue3-vite 项目名称
#√ Select a framework: » Vue      使用的框架
#√ Select a variant: » TypeScript 使用的语言

# 安装依赖
pnpm install

# 运行程序
pnpm run dev

2 eslint语法校验

# 安装插件
pnpm i eslint -D

# 生成配置文件
npx eslint --init

2.1 默认.eslint.cjs配置文件

module.exports = {
   //运行环境
    "env": { 
        "browser": true,//浏览器端
        "es2021": true,//es2021
    },
    //规则继承
    "extends": [ 
       //全部规则默认是关闭的,这个配置项开启推荐规则,推荐规则参照文档
       //比如:函数不能重名、对象不能出现重复key
        "eslint:recommended",
        //vue3语法规则
        "plugin:vue/vue3-essential",
        //ts语法规则
        "plugin:@typescript-eslint/recommended"
    ],
    //要为特定类型的文件指定处理器
    "overrides": [
    ],
    //指定解析器:解析器
    //Esprima 默认解析器
    //Babel-ESLint babel解析器
    //@typescript-eslint/parser ts解析器
    "parser": "@typescript-eslint/parser",
    //指定解析器选项
    "parserOptions": {
        "ecmaVersion": "latest",//校验ECMA最新版本
        "sourceType": "module"//设置为"script"（默认），或者"module"代码在ECMAScript模块中
    },
    //ESLint支持使用第三方插件。在使用插件之前，您必须使用npm安装它
    //该eslint-plugin-前缀可以从插件名称被省略
    "plugins": [
        "vue",
        "@typescript-eslint"
    ],
    //eslint规则
    "rules": {
    }
}

2.2 vue3环境代码校验插件

// 让所有与prettier规则存在冲突的Eslint rules失效，并使用prettier进行代码检查
"eslint-config-prettier": "^8.6.0",
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-node": "^11.1.0",
// 运行更漂亮的Eslint，使prettier规则优先级更高，Eslint优先级低
"eslint-plugin-prettier": "^4.2.1",
// vue.js的Eslint插件（查找vue语法错误，发现错误指令，查找违规风格指南
"eslint-plugin-vue": "^9.9.0",
// 该解析器允许使用Eslint校验所有babel code
"@babel/eslint-parser": "^7.19.1",

安装指令

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

2.3 修改.eslintrc.cjs配置文件

eslint.bootcss.com/docs/rules/

module.exports = {
    env: {
        browser: true,
        es2021: true,
        node: true,
        jest: true
    },
    /* 指定如何解析语法 */
    parser: 'vue-eslint-parser',
    /** 优先级低于 parse 的语法解析配置 */
    parserOptions: {
        ecmaVersion: 'latest',
        sourceType: 'module',
        parser: '@typescript-eslint/parser',
        jsxPragma: 'React',
        ecmaFeatures: {
            jsx: true
        }
    },
    /* 继承已有的规则 */
    extends: [
        'eslint:recommended',
        'plugin:vue/vue3-essential',
        'plugin:@typescript-eslint/recommended',
        'plugin:prettier/recommended'
    ],
    plugins: ['vue', '@typescript-eslint'],
    /*
     * "off" 或 0    ==>  关闭规则
     * "warn" 或 1   ==>  打开的规则作为警告（不影响代码执行）
     * "error" 或 2  ==>  规则作为一个错误（代码不能执行，界面报错）
     */
    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' // 对模板中的自定义组件强制执行属性命名样式
    }
}

2.4 忽略校验文件 .eslintignore

在项目根目录下创建文件：.eslintignore

dist
node_modules

2.5 配置运行脚本

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

3 配置prettier

有了eslint，为什么还要有prettier？eslint针对的是javascript，他是一个检测工具，包含js语法以及少部分格式问题，在eslint看来，语法对了就能保证代码正常运行，格式问题属于其次。

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

总结起来，eslint和prettier这俩兄弟一个保证js代码质量，一个保证代码美观。

通过pnpm run lint去检测语法，如果出现不规范格式,通过pnpm run fix 修改

3.1 安装依赖包

pnpm install -D eslint-plugin-prettier prettier eslint-config-prettier

3.2 添加格式化规则.prettierrc.json

在项目根目录下创建文件：.prettierrc.json

{
    "singleQuote": true,
    "semi": false,
    "bracketSpacing": true,
    "htmlWhitespaceSensitivity": "ignore",
    "endOfLine": "auto",
    "trailingComma": "all",
    "tabWidth": 4
}

3.3 添加忽略文件.prettierignore

在项目根目录下创建文件：.prettierignore

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

4 配置stylelint

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

4.1 安装依赖包

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

pnpm 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

4.2 配置文件.stylelintrc.cjs

官网:stylelint.bootcss.com/

// @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默认样式的时候能使用到
            }
        ]
    }
}

4.3 配置忽略文件.stylelintignore

在项目根目录下创建文件：.stylelintignore

/node_modules/*
/dist/*
/html/*
/public/*

4.4 配置运行脚本package.json

{
	"scripts": {
        "lint:style": "stylelint src/**/*.{css,scss,vue} --cache --fix"
    }
}

最后配置统一的prettier来格式化我们的js和css，html代码

{
	"scripts": {
        "dev": "vite --open",
        "build": "vue-tsc && vite build",
        "preview": "vite preview",
        "lint": "eslint src",
        "fix": "eslint src --fix",
        "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"
    }
}

当我们运行pnpm run format的时候，会把代码直接格式化

5 配置husky

在上面我们已经集成好了我们代码校验工具，但是需要每次手动的去执行命令才会格式化我们的代码。如果有人没有格式化就提交了远程仓库中，那这个规范就没什么用。所以我们需要强制让开发人员按照代码规范来提交。

要做到这件事情，就需要利用husky在代码提交之前触发git hook(git在客户端的钩子)，然后执行pnpm run format来自动的格式化我们的代码。

5.1 安装依赖

# 安装husky
pnpm install -D husky

# 初始化husky，注意执行初始化命令之前，项目必须是已经是.git仓库。如果执行错误需要删除package.json中的一些错误信息。比如"prepare": "husky install"配置选项
npx husky-init

5.2 配置规则pre-commit

执行npx husky-init命令执行成功后会在根目录下生成个一个.husky目录，在这个目录下面会有一个pre-commit文件，这个文件里面的命令在我们执行commit的时候就会执行。

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

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

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

6 配置commitlint

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

6.1 安装依赖

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

6.2 添加配置文件commitlint.config.cjs

添加配置文件，新建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]
    }
}

6.3 配置执行脚本package.json

在package.json中添加如下命令

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

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

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

6.4 配置husky

在.husky中生成commit-msg命令文件

npx husky add .husky/commit-msg

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

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

pnpm commitlint

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

7 强制使用pnpm包管理器

团队开发项目的时候，需要统一包管理器工具,因为不同包管理器工具下载同一个依赖,可能版本不一样，导致项目出现bug问题,因此包管理器工具需要统一管理！！！

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

7.1 创建配置文件scripts/preinstall.js

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

// 配置必须使用pnpm包管理器
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)
}

7.2 配置命令package.json

目前使用好像无效：执行npm命令下载包之前不会报错。

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

8 环境变量配置

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

开发环境（development）：顾名思义，开发使用的环境，每位开发人员在自己的dev分支上干活，开发到一定程度，同事会合并代码，进行联调。

测试环境（testing）：测试同事干活的环境啦，一般会由测试同事自己来部署，然后在此环境进行测试。

生产环境（production）：生产环境是指正式提供对外服务的，一般会关掉错误报告，打开错误日志。（正式提供给客户使用的环境）

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

配置成功后可以通过import.meta.env获取环境变量

8.1 添加配置文件

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

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

8.2 不同环境配置内容

.env.development

# 变量必须以 VITE_ 为前缀才能暴露给外部读取
NODE_ENV = 'development'
VITE_APP_TITLE = 'xyz办公管理平台'
VITE_APP_BASE_API = '/dev-api'

.env.production

# 变量必须以 VITE_ 为前缀才能暴露给外部读取
NODE_ENV = 'production'
VITE_APP_TITLE = 'xyz办公管理平台'
VITE_APP_BASE_API = '/prod-api'

.env.test

# 变量必须以 VITE_ 为前缀才能暴露给外部读取
NODE_ENV = 'test'
VITE_APP_TITLE = 'xyz办公管理平台'
VITE_APP_BASE_API = '/test-api'

8.3 配置运行命令package.json

{
	"scripts": {
        "dev": "vite --open", // 未指定模式的默认取 .env.development 文件中的配置
        "build:test": "vue-tsc && vite build --mode test", // 取 .env.test文件中的配置
        "build:prod": "vue-tsc && vite build --mode production", // 取 .env.production文件中的配置
        "preview": "vite preview"
    }
}

8.4 获取环境变量

配置成功后可以通过import.meta.env获取环境变量

<script setup lang="ts">
// 获取环境变量信息
console.log('import.meta.env', import.meta.env)
console.log('import.meta.env.VITE_APP_BASE_API', import.meta.env.VITE_APP_BASE_API)
</script>

配置env.d.ts文件

在src目录下env.d.ts中添加以下代码，可以在在代码中获取用户自定义环境变量的 TypeScript 智能提示：

/// <reference types="vite/client" />
interface ImportMetaEnv {
    readonly VITE_APP_TITLE: string
    readonly VITE_APP_BASE_API: string
    // 更多环境变量...
}

9 SVG图标配置

在开发项目的时候经常会用到svg矢量图，而且我们使用SVG以后，页面上加载的不再是图片资源，这对页面性能来说是个很大的提升，而且我们SVG文件比img要小的很多，放在项目中几乎不占用资源。

9.1 安装SVG依赖插件

pnpm install vite-plugin-svg-icons -D

9.2 配置插件vite.config.ts

在vite.config.ts中配置插件

import {createSvgIconsPlugin} from 'vite-plugin-svg-icons'
import path from 'path'

// https://vitejs.dev/config/
export default defineConfig({
    plugins: [
        vue(),
        createSvgIconsPlugin({
            // 指定要缓存的图标文件夹
            iconDirs: [path.resolve(process.cwd(), 'src/assets/icons')],
            // 指定符号ID格式
            symbolId: 'icon-[dir]-[name]',
        }),
    ],
})

9.3 导入插件

在根目录src/main.ts中导入

import 'virtual:svg-icons-register'

9.4 将svg封装为全局组件

1、svg组件

因为项目很多模块需要使用svg图标，因此把它封装为全局组件，在src/components目录下创建一个SvgIcon组件：

<script setup lang="ts">
defineProps({
    //xlink:href属性值的前缀
    prefix: {
        type: String,
        default: '#icon-',
    },
    //svg矢量图的名称
    name: String,
    //svg图标的颜色
    color: {
        type: String,
        default: '',
    },
    //svg图标的宽度
    width: {
        type: String,
        default: '16px',
    },
    //svg图标的高度
    height: {
        type: String,
        default: '16px',
    },
})
</script>

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

<style scoped></style>

2、注册为全局组件

在src/components文件夹目录下创建一个index.ts文件：用于注册components文件夹内部全部全局组件。

src/components/index.ts

import SvgIcon from './SvgIcon.vue'
import type {App, Component} from 'vue'

const components: { [name: string]: Component } = {SvgIcon}
// 注册组件
export default {
    install(app: App) {
        Object.keys(components).forEach((key: string) => {
            app.component(key, components[key])
        })
    },
}

在项目的入口文件引入src/main.ts文件，通过app.use()方法安装自定义插件

import {createApp} from 'vue'
import App from './App.vue'
import 'virtual:svg-icons-register'
import gloableComponent from './components/index.ts'

const app = createApp(App)
app.use(gloableComponent)
app.mount('#app')

10 mock数据

10.1 安装依赖

安装依赖:www.npmjs.com/package/vit…

pnpm install -D vite-plugin-mock mockjs

10.2 启用插件vite.config.js

在 vite.config.js 配置文件启用插件。

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

10.3 创建我们需要mock数据与接口

在根目录创建mock文件夹：去创建我们需要mock数据与接口，在mock文件夹内部创建一个user.ts文件

// 用户信息数据
function createUserList() {
    return [
        {
            userId: 10001,
            img: 'http://xuyizhuo.xyz/azhuo.gif',
            username: 'azhuo',
            password: 'xu123',
            token: 'azhuo Token',
        },
        {
            userId: 10000,
            img: 'http://xuyizhuo.xyz/admin.gif',
            username: 'admin',
            password: 'xu123',
            token: 'admin 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} }
        },
    },
]

11 axios二次封装

11.1 安装axios

pnpm install axios

11.2 二次封装

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

目的：

1、使用请求拦截器，可以在请求拦截器中处理一些业务（开始进度条、请求头携带公共参数）

2、使用响应拦截器，可以在响应拦截器中处理一些业务（进度条结束、简化服务器返回的数据、处理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;

12 API接口统一管理

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

//统一管理咱们项目用户相关的接口
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)