本文整理来自深入Vue3+TypeScript技术栈-coderwhy大神新课,只作为个人笔记记录使用,请大家多支持王红元老师。
一. 代码规范
1 - 集成editorconfig配置
.editorconfig文件
有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。
# Editor configuration, see http://editorconfig.org
# 表示是最顶层的 EditorConfig 配置文件
root = true
[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格(tab | space)
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf), lf 适配 mac,linix ; cr 适配window;
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行
[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false
如果想VSCode读取这个文件,需要安装一个插件:EditorConfig for VS Code。
2 - 使用prettier工具
Prettier 是一款强大的代码格式化工具,支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言,基本上前端能用到的文件格式它都可以搞定,是当下最流行的代码格式化工具。
如果使用的是VSCode,使用Prettier - Code formatter插件,按command+s保存即可对代码进行格式化。如果使用的不是VSCode,甚至你想敲一个命令,通过这个命令就能对代码进行格式化,这时候最好在项目中安装Prettier的包, 安装之后,即使不用VSCode也可以对我们的代码进行格式化的。啥意思呢?也就是Prettier包是针对我们的项目的,插件是针对于VSCode的。
- 安装prettier
npm install prettier -D
- 配置
.prettierrc
文件
{
"useTabs": false,
"tabWidth": 2,
"printWidth": 80,
"singleQuote": true,
"trailingComma": "none",
"semi": false
}
useTabs:使用tab缩进还是空格缩进,选择false,使用空格;
tabWidth:tab是空格的情况下,是几个空格,选择2个;
printWidth:一行代码的长度,推荐80,也有人喜欢100或者120;
singleQuote:使用单引号还是双引号,选择true,使用单引号;
trailingComma:在多行输入的时候尾部是否添加逗号,设置为 `none`;
semi:语句末尾是否要加分号,默认值true,选择false表示不加;
- 创建
.prettierignore
忽略文件
/dist/*
.local
.output.js
/node_modules/**
**/*.svg
**/*.sh
/public/*
- VSCode需要安装prettier的插件
- 测试prettier是否生效
在代码中command+s保存代码,测试是否生效。如果我们去每个文件,然后一个一个command+s会很麻烦,我们可以在package.json中配置一个scripts,如下,这样我们执行npm run prettier
命令就可以将项目中所有的文件格式化了。
"prettier": "prettier --write ."
当我们使用prettier格式化后的代码可能和ESLint的规则有冲突,从而有警告,下面讲一下ESLint。
3 - 使用ESLint检测
ESLint是为了检查我们的代码是否规范。
在前面创建项目的时候,我们就选择了ESLint,所以Vue会默认帮助我们配置需要的ESLint环境,然后自动生成
.eslintrc.js
文件。VSCode需要安装ESLint插件
ESLint插件可以快速对我们的代码进行检查,从而报警告。
- 解决eslint和prettier冲突的问题
上面的.eslintrc.js
文件,核心规范如下:
extends: [
"plugin:vue/vue3-essential", // vue3的规范
"eslint:recommended", // eslint默认推荐的规范
"@vue/typescript/recommended", // 在vue里面使用typescript的规范
"@vue/prettier", // 默认vue里面prettier的规范
"@vue/prettier/@typescript-eslint", // 默认vue里面prettier的typescript的规范
],
也就是说我们的代码需要符合上面那些规范,但是上面那些规范和.prettierrc
里面的东西是冲突的,也就是说我们格式化之后代码会有警告,那么我们怎么让它兼容起来呢?
我们需要安装两个插件(vue在创建项目时,如果选择prettier,那么这两个插件会自动安装,就不用我们手动安装了)。
npm i eslint-plugin-prettier eslint-config-prettier -D
这两个插件就是用来做eslint和prettier兼容的,在extends中添加如下一行代码,表示用刚才的插件,然后重启项目,就不会警告了。
extends: [
......
'plugin:prettier/recommended'
],
上面extends的规则都是继承,但是规则有相同的情况下,后面的会把前面的覆盖掉。
4 - git Husky和eslint
虽然我们已经要求项目使用eslint了,但是不能保证组员提交代码之前都将eslint中的问题解决掉了,也就是我们希望保证代码仓库中的代码都是符合eslint规范的,那么我们需要在组员执行 git commit
命令的时候对其进行校验,如果不符合eslint规范,那么自动通过规范进行修复。
那么如何做到这一点呢?可以通过Husky工具,husky是一个git hook工具,可以帮助我们触发git提交的各个阶段:pre-commit、commit-msg、pre-push。
如何使用husky呢?这里我们可以使用自动配置命令:
npx husky-init && npm install
这个命令其实就是帮我们完成了三个操作:
- 安装husky相关的依赖
- 在项目目录下创建
.husky
文件夹
npx huksy install
文件夹下面有个pre-commit文件,如果我们想在commit之前做一些事,可以在这个文件里面写操作。
- 在package.json中添加一个脚本
- 接下来,我们需要去完成一个操作:在进行commit时,执行lint脚本
这个时候我们执行git commit的时候会自动对代码进行lint校验。
5 - git commit规范
1. 代码提交风格
通常我们的git commit会按照统一的风格来提交,这样可以快速定位每次提交的内容,方便之后对版本进行控制。
但是如果每次手动来编写这些是比较麻烦的事情,我们可以使用一个工具:Commitizen,Commitizen 是一个帮助我们编写规范 commit message 的工具。
- 安装Commitizen
npm install commitizen -D
- 安装cz-conventional-changelog,并且初始化cz-conventional-changelog
npx commitizen init cz-conventional-changelog --save-dev --save-exact
这个命令会帮助我们安装cz-conventional-changelog:
并且在package.json中进行配置:
这时候我们提交代码需要使用npx cz
,执行之后会出现终端选择界面:
- 第一步是选择提交的type,本次更新的类型
Type | 作用 |
---|---|
feat | 新增特性 (feature) |
fix | 修复 Bug(bug fix) |
docs | 修改文档 (documentation) |
style | 代码格式修改(white-space, formatting, missing semi colons, etc) |
refactor | 代码重构(refactor) |
perf | 改善性能(A code change that improves performance) |
test | 测试(when adding missing tests) |
build | 变更项目构建或外部依赖(例如 scopes: webpack、gulp、npm 等) |
ci | 更改持续集成软件的配置文件和 package 中的 scripts 命令,例如 scopes: Travis, Circle 等 |
chore | 变更构建流程或辅助工具(比如更改测试环境) |
revert | 代码回退 |
- 第二步选择本次修改的范围(作用域)
- 第三步选择提交的信息
- 第四步提交详细的描述信息
- 第五步是否是一次重大的更改
- 第六步是否影响某个open issue
如果有组员不喜欢npx cz
命令,我们可以在scripts中构建一个命令来执行cz,如下,我们执行npm run commit
即可进行提交操作。
2. 代码提交验证
如果我们按照cz来规范了提交风格,但是依然有同事通过 git commit
按照不规范的格式提交应该怎么办呢?我们可以通过commitlint来限制提交。
- 安装 @commitlint/config-conventional 和 @commitlint/cli
npm i @commitlint/config-conventional @commitlint/cli -D
- 在根目录创建commitlint.config.js文件,配置commitlint,代码如下:
module.exports = {
extends: ['@commitlint/config-conventional']
}
上面我们讲的pre-commit文件是commit之前的拦截文件,我们还需要拦截提交信息的文件,如下:
- 使用husky生成commit-msg文件,用来验证提交信息:
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
这时候我们再使用git commit提交代码的时候,如果不符合commitlint.config.js规范,就会报错。
二. 第三方库集成
1 - vue.config.js配置
我们都知道vue-cli是基于webpack来配置的,但是有时候我们对于vue-cli的默认配置不是很满意,这时候我们可以通过修改webpack源码(不推荐)来达到我们的目的,另外一种方式就是通过vue.config.js来配置,最后vue.config.js的配置会被合并到webpack里面的。如果不知道怎么配置,可以参开官网:https://cli.vuejs.org/zh/config/。
vue.config.js有三种配置方式:
方式一:直接通过CLI提供给我们的选项来配置
① 比如publicPath:配置应用程序部署的子目录(默认是/
,相当于部署在https://www.my-app.com/
),如果想修改成https://www.my-app.com/why
,就配置publicPath:'/why'
;
② 比如outputDir:修改输出的文件夹,默认是dist文件夹,如果想修改成build文件夹,可以配置outputDir:'./bulid'
;方式二:通过configureWebpack修改webpack的配置
可以是一个对象,直接会被合并;
可以是一个函数,会接收一个config,可以通过config来修改配置;方式三:通过chainWebpack修改webpack的配置
是一个函数,会接收一个基于 webpack-chain 的config对象,可以对配置进行修改;
const path = require('path')
module.exports = {
// 1.配置方式一: CLI提供的属性, 名称不一定相同,但是和webpack里面的配置是对应的
outputDir: './build',
publicPath: './',
// 2.配置方式二: 和webpack属性完全一致, 最后会进行合并
// 对象方式
configureWebpack: {
resolve: {
alias: {
// 配置别名 默认情况下@就相当于src,所以'@/components'就相当于'src/components'
// 配置别名之后,我们以前写的import HelloWorld from './components/HelloWorld.vue'就可以写成
// import HelloWorld from '@/components/HelloWorld.vue' 甚至更简,写成:
// import HelloWorld from 'components/HelloWorld.vue', 因为我们配置了别名components就相当于@/components
// 也就是'src/components'
components: '@/components'
}
}
},
// 函数方式
configureWebpack: (config) => {
config.resolve.alias = {
// 写成函数就是把原来的alias给覆盖掉,所以我们要重新指定@就是src,其实webpack默认配置@的别名就是这样配置的
'@': path.resolve(__dirname, 'src'),
// 再配置别名
components: '@/components'
}
}
// 3.配置方式三:
chainWebpack: (config) => {
config.resolve.alias
.set('@', path.resolve(__dirname, 'src'))
.set('components', '@/components')
}
}
这三种方式使用哪一种都可以,只要达到修改的目的就行。
2 - vue-router集成
刚开始创建项目的时候我们没有选择路由,现在我们手 动集成路由。
- 安装vue-router的最新版本
npm install vue-router@next
- 创建router对象
创建router文件夹,router文件夹里面创建index.ts文件,代码如下:
import { createRouter, createWebHashHistory } from 'vue-router'
// 导入类型注解,添加一个type代表我们导入的东西不是其他,而是一个类型,不加也没事
import type { RouteRecordRaw } from 'vue-router'
// 使用类型注解,代表数组里面装的都是RouteRecordRaw
const routes: RouteRecordRaw[] = [
{
path: '/',
redirect: '/login'
},
{
path: '/login',
// 路由懒加载
component: () => import('@/views/login/login.vue')
},
{
path: '/main',
component: () => import('@/views/main/main.vue')
}
]
const router = createRouter({
routes,
history: createWebHashHistory()
})
export default router
- 使用router
在main.ts里面使用router,代码如下:
import { createApp } from 'vue'
import App from './App.vue'
import router from './router'
const app = createApp(App)
app.use(router)
app.mount('#app')
- 在App.vue中配置跳转
登录
首页
3 - vuex集成
- 安装vuex
npm install vuex@next
- 创建store对象
创建store文件夹,store文件夹里面创建index.js文件,代码如下:
import { createStore } from 'vuex'
const store = createStore({
state: () => {
return {
name: 'coderwhy'
}
},
mutations: {},
getters: {},
actions: {}
})
export default store
- 使用store
在main.ts里面使用store,如下:
createApp(App).use(router).use(store).mount('#app')
- 在App.vue中使用
{{ $store.state.name }}
其实vuex对于TS的支持相对来说差一点,所以很多人使用第三方库Pinia,第三方库会好一点点。
4 - Element-Plus集成
相信很多同学在Vue2中都使用过Element-UI,Element-Plus是一套为开发者、设计师和产品经理准备的基于 Vue 3.0 的桌面端组件库。它的使用方式和很多其他的组件库是一样的,所以学会Element-Plus,其他类似于VantUI、NaiveUI、ant-design-vue都是差不多的。
安装element-plus:
npm install element-plus
1 - 全局引入
一种引入element-plus的方式是全局引入,代表的含义是所有的组件和插件都会被自动注册。
优点:集成简单
缺点:全部会打包
// 1. 引入包
import ElementPlus from 'element-plus'
// 2. 引入样式
import 'element-plus/lib/theme-chalk/index.css'
import router from './router'
import store from './store'
// 3. 挂载
createApp(App).use(router).use(store).use(ElementPlus).mount('#app')
在App.vue里面直接使用即可:
哈哈哈哈
2 - 按需引入
按需引入也就是在开发中用到某个组件对某个组件进行引入。
优点:包会小一些
缺点:集成起来麻烦一些
登录
首页
{{ $store.state.name }}
// 使用组件
默认按钮
主要按钮
成功按钮
信息按钮
警告按钮
危险按钮
但是我们会发现是没有对应的样式的,引入样式有两种方式:
- 全局引用样式(像之前做的那样),不推荐,因为一些没用到的样式也会被打包进来
- 局部引用样式(通过babel的插件)
- 安装babel的插件
npm install babel-plugin-import -D
- 配置babel.config.js
module.exports = {
plugins: [
[
'import',
{
libraryName: 'element-plus',
customStyleName: (name) => {
return `element-plus/lib/theme-chalk/${name}.css`
}
}
]
],
presets: ['@vue/cli-plugin-babel/preset']
}
这个插件只会在我们用到某个组件的时候同时给我们引用对应的css,但是我们的base或者说一些icon图标是不会帮我们引用进去的,所以对于基本的东西,我们可以全局进行引用。
import 'element-plus/lib/theme-chalk/base.css'
但是这里依然有个弊端,这些组件我们在多个页面或者组件中使用的时候,都需要导入并且在components中进行注册,所以我们可以使用app.component进行全局注册。
为了防止main.ts里面代码太多,这里我们可以封装一下。我们新建global文件夹,在里面新建register-element.ts文件和index.ts文件。
register-element.ts文件代码如下:
import { App } from 'vue'
// 导入base
import 'element-plus/lib/theme-chalk/base.css'
import {
ElButton,
ElCheckbox,
ElForm,
ElFormItem,
ElInput,
ElLink,
ElRadio,
ElTabPane,
ElTabs
} from 'element-plus'
const components = [
ElButton,
ElForm,
ElFormItem,
ElInput,
ElRadio,
ElTabs,
ElTabPane,
ElCheckbox,
ElLink
]
export default function (app: App): void {
for (const component of components) {
app.component(component.name, component)
}
}
index.ts文件代码如下:
import { App } from 'vue'
import registerElement from './register-element'
export function registerApp(app: App): void {
registerElement(app)
}
main.ts代码如下:
import { createApp } from 'vue'
import { registerApp } from './global'
import App from './App.vue'
const app = createApp(App)
registerApp(app)
app.mount('#app')
如果我们想通过插件的方式,也就是使用app.use()的方式,那么如何写代码呢?
前面我们说过,app.use()如果传入一个function,那么这个function会有个app参数,如果传入一个对象,那么默认会执行这个对象的install方法,install方法也有一个app参数。所以,代码修改如下:
index.ts代码如下:
import { App } from 'vue'
import registerElement from './register-element'
export function globalRegister(app: App): void {
// 调用registerElement, 并把app传进去
app.use(registerElement)
}
main.ts代码如下:
import { createApp } from 'vue'
import { globalRegister } from './global'
import App from './App.vue'
const app = createApp(App)
// 调用globalRegister,并把app传进去
app.use(globalRegister)
app.mount('#app')
三. 接口文档
https://documenter.getpostman.com/view/12387168/TzsfmQvw
baseURL的值:
http://152.136.185.210:5000
设置全局token的方法:
const res = pm.response.json();
pm.globals.set("token", res.data.token);
接口文档v2版本:(有部分更新)
https://documenter.getpostman.com/view/12387168/TzzDKb12
四. 其他补充
VSCode配置
{
"workbench.iconTheme": "vscode-great-icons",
"editor.fontSize": 17,
"eslint.migration.2_x": "off",
"[javascript]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"files.autoSave": "afterDelay",
"editor.tabSize": 2,
"terminal.integrated.fontSize": 16,
"editor.renderWhitespace": "all",
"editor.quickSuggestions": {
"strings": true
},
"debug.console.fontSize": 15,
"window.zoomLevel": 1,
"emmet.includeLanguages": {
"javascript": "javascriptreact"
},
"explorer.confirmDragAndDrop": false,
"workbench.tree.indent": 16,
"javascript.updateImportsOnFileMove.enabled": "always",
"editor.wordWrap": "on",
"path-intellisense.mappings": {
"@": "${workspaceRoot}/src"
},
"hediet.vscode-drawio.local-storage": "eyIuZHJhd2lvLWNvbmZpZyI6IntcImxhbmd1YWdlXCI6XCJcIixcImN1c3RvbUZvbnRzXCI6W10sXCJsaWJyYXJpZXNcIjpcImdlbmVyYWw7YmFzaWM7YXJyb3dzMjtmbG93Y2hhcnQ7ZXI7c2l0ZW1hcDt1bWw7YnBtbjt3ZWJpY29uc1wiLFwiY3VzdG9tTGlicmFyaWVzXCI6W1wiTC5zY3JhdGNocGFkXCJdLFwicGx1Z2luc1wiOltdLFwicmVjZW50Q29sb3JzXCI6W1wiRkYwMDAwXCIsXCIwMENDNjZcIixcIm5vbmVcIixcIkNDRTVGRlwiLFwiNTI1MjUyXCIsXCJGRjMzMzNcIixcIjMzMzMzM1wiLFwiMzMwMDAwXCIsXCIwMENDQ0NcIixcIkZGNjZCM1wiLFwiRkZGRkZGMDBcIl0sXCJmb3JtYXRXaWR0aFwiOjI0MCxcImNyZWF0ZVRhcmdldFwiOmZhbHNlLFwicGFnZUZvcm1hdFwiOntcInhcIjowLFwieVwiOjAsXCJ3aWR0aFwiOjExNjksXCJoZWlnaHRcIjoxNjU0fSxcInNlYXJjaFwiOnRydWUsXCJzaG93U3RhcnRTY3JlZW5cIjp0cnVlLFwiZ3JpZENvbG9yXCI6XCIjZDBkMGQwXCIsXCJkYXJrR3JpZENvbG9yXCI6XCIjNmU2ZTZlXCIsXCJhdXRvc2F2ZVwiOnRydWUsXCJyZXNpemVJbWFnZXNcIjpudWxsLFwib3BlbkNvdW50ZXJcIjowLFwidmVyc2lvblwiOjE4LFwidW5pdFwiOjEsXCJpc1J1bGVyT25cIjpmYWxzZSxcInVpXCI6XCJcIn0ifQ==",
"hediet.vscode-drawio.theme": "Kennedy",
"editor.fontFamily": "Source Code Pro, 'Courier New', monospace",
"editor.smoothScrolling": true,
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"workbench.colorTheme": "Atom One Dark",
"vetur.completion.autoImport": false,
"security.workspace.trust.untrustedFiles": "open",
"eslint.lintTask.enable": true,
"eslint.alwaysShowStatus": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}
.browserslistrc文件
这个文件是进行浏览器适配的。
> 1% //适配市场份额大于1%的浏览器
last 2 versions //适配主流浏览器最新的两个版本
not dead //适配没有死的浏览器,如果12个月内有更新,那就是没有死
tsconfig.json文件
如果项目中有使用TS,就会有这个文件,用来做TS相关的配置。
{
//编译选项
"compilerOptions": {
// 目标代码(ts -> js(es5/6/7))
"target": "esnext",
// 目标代码需要使用的模块化方案(commonjs require/module.exports/es module import/export)
// 如果设置为umd就是支持多种模块化
"module": "esnext",
// 打开一些严格的检查
"strict": true,
// 对jsx进行怎么样的处理 preserve保留,不转换
"jsx": "preserve",
// 导入辅助功能
"importHelpers": true,
// 按照node的方式去解析模块 import "/index.node"
"moduleResolution": "node",
// 跳过三方库的类型检测 (axios -> 类型/ lodash -> @types/lodash / 其他的第三方)
// import { Person } from 'axios'
"skipLibCheck": true,
// es module 和 commonjs能不能混合来使用,下面俩属性一般是一起的
// export default/module.exports = {}
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
// 要不要生成映射文件(ts -> js)
"sourceMap": true,
// 文件路径在解析时的基本url, 默认是以当前文件为准
"baseUrl": ".",
// 指定具体要解析使用的类型
"types": ["webpack-env"],
// 路径解析(类似于webpack alias)
"paths": {
"@/*": ["src/*"],
"components/*": ["src/components/*"]
},
// 指定在项目中可以使用哪里库的类型(Proxy/Window/Document)
"lib": ["esnext", "dom", "dom.iterable", "scripthost"]
},
// 哪些ts代码需要进行编译解析
"include": [
"src/**/*.ts",
"src/**/*.tsx",
"src/**/*.vue",
"tests/**/*.ts",
"tests/**/*.tsx"
],
// 哪些ts代码不需要进行编译解析
// 比如当我们导入axios的时候,其实axios就是在node_modules里面的
// 如果我们把它排除,就是引入的库的在node_modules里面的代码不进行解析,但是我们自己写的关于axios的代码还是会被解析
"exclude": ["node_modules"]
}
这个文件的配置有个大概的了解就可以,因为最终我们都会通过Babel进行转换的。
shims-vue.d.ts文件
当我们加载一些比较特殊的文件,比如.vue文件、.png文件,其实默认TS是不认识这些文件的,就会报错。但是我们在main.ts里面使用App.vue文件是不会报错的, 这是因为当前项目是通过脚手架创建的,也就是说这些配置默认都给我们配好了,其实这些文件的类型声明就是在shims-vue.d.ts文件里面。
shims-vue.d.ts文件:
/* eslint-disable */
declare module '*.vue' {
import type { DefineComponent } from 'vue'
const component: DefineComponent<{}, {}, any>
export default component
}
declare let $store: any
defineComponent()的作用
当我们在.vue文件中使用TS,代码如下:
和原来相比多了lang="ts",代表我们使用TS编写代码,还有多了defineComponent()函数进行包裹,其实defineComponent的作用就是类型限制和类型推导。