一. 代碼規(guī)范
1.1. 集成editorconfig配置
EditorConfig 有助于為不同 IDE 編輯器上處理同一項(xiàng)目的多個(gè)開(kāi)發(fā)人員維護(hù)一致的編碼風(fēng)格。
# http://editorconfig.orgroot=true[*]# 表示所有文件適用charset=utf-8# 設(shè)置文件字符集為 utf-8indent_style=space# 縮進(jìn)風(fēng)格（tab | space）indent_size=2# 縮進(jìn)大小end_of_line=lf# 控制換行類型(lf | cr | crlf)trim_trailing_whitespace=true# 去除行首的任意空白字符insert_final_newline=true# 始終在文件末尾插入一個(gè)新行[*.md]# 表示僅 md 文件適用以下規(guī)則max_line_length=offtrim_trailing_whitespace=false
VSCode需要安裝一個(gè)插件：EditorConfig for VS Code
1.2. 使用prettier工具
Prettier 是一款強(qiáng)大的代碼格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等語(yǔ)言，基本上前端能用到的文件格式它都可以搞定，是當(dāng)下最流行的代碼格式化工具。
1.安裝prettier
npm install prettier -D
2.配置.prettierrc文件：
useTabs：使用tab縮進(jìn)還是空格縮進(jìn)，選擇false；
tabWidth：tab是空格的情況下，是幾個(gè)空格，選擇2個(gè)；
printWidth：當(dāng)行字符的長(zhǎng)度，推薦80，也有人喜歡100或者120；
singleQuote：使用單引號(hào)還是雙引號(hào)，選擇true，使用單引號(hào)；
trailingComma：在多行輸入的尾逗號(hào)是否添加，設(shè)置為?none；
semi：語(yǔ)句末尾是否要加分號(hào)，默認(rèn)值true，選擇false表示不加；
{"useTabs":false,"tabWidth":2,"printWidth":80,"singleQuote":true,"trailingComma":"none","semi":false}
3.創(chuàng)建.prettierignore忽略文件
/dist/*
.local
.output.js
/node_modules/**
**/*.svg
**/*.sh
/public/*
4.VSCode需要安裝prettier的插件
5.測(cè)試prettier是否生效
測(cè)試一：在代碼中保存代碼；
測(cè)試二：配置一次性修改的命令；
在package.json中配置一個(gè)scripts：
"prettier":"prettier --write ."
1.3. 使用ESLint檢測(cè)
1.在前面創(chuàng)建項(xiàng)目的時(shí)候，我們就選擇了ESLint，所以Vue會(huì)默認(rèn)幫助我們配置需要的ESLint環(huán)境。
2.VSCode需要安裝ESLint插件：
3.解決eslint和prettier沖突的問(wèn)題：
安裝插件：（vue在創(chuàng)建項(xiàng)目時(shí)，如果選擇prettier，那么這兩個(gè)插件會(huì)自動(dòng)安裝）
npm i eslint-plugin-prettier eslint-config-prettier -D
添加prettier插件：
extends: ["plugin:vue/vue3-essential","eslint:recommended","@vue/typescript/recommended","@vue/prettier","@vue/prettier/@typescript-eslint",? ? 'plugin:prettier/recommended'? ],
1.4. git Husky和eslint
雖然我們已經(jīng)要求項(xiàng)目使用eslint了，但是不能保證組員提交代碼之前都將eslint中的問(wèn)題解決掉了：
也就是我們希望保證代碼倉(cāng)庫(kù)中的代碼都是符合eslint規(guī)范的；
那么我們需要在組員執(zhí)行?git commit?命令的時(shí)候?qū)ζ溥M(jìn)行校驗(yàn)，如果不符合eslint規(guī)范，那么自動(dòng)通過(guò)規(guī)范進(jìn)行修復(fù)；
那么如何做到這一點(diǎn)呢？可以通過(guò)Husky工具：
husky是一個(gè)git hook工具，可以幫助我們觸發(fā)git提交的各個(gè)階段：pre-commit、commit-msg、pre-push
如何使用husky呢？
這里我們可以使用自動(dòng)配置命令：
npx husky-init && npm install
這里會(huì)做三件事：
1.安裝husky相關(guān)的依賴：
2.在項(xiàng)目目錄下創(chuàng)建?.husky?文件夾：
npx huksy install
3.在package.json中添加一個(gè)腳本：
接下來(lái)，我們需要去完成一個(gè)操作：在進(jìn)行commit時(shí)，執(zhí)行l(wèi)int腳本：
這個(gè)時(shí)候我們執(zhí)行g(shù)it commit的時(shí)候會(huì)自動(dòng)對(duì)代碼進(jìn)行l(wèi)int校驗(yàn)。
1.5. git commit規(guī)范
1.5.1. 代碼提交風(fēng)格
通常我們的git commit會(huì)按照統(tǒng)一的風(fēng)格來(lái)提交，這樣可以快速定位每次提交的內(nèi)容，方便之后對(duì)版本進(jìn)行控制。
但是如果每次手動(dòng)來(lái)編寫(xiě)這些是比較麻煩的事情，我們可以使用一個(gè)工具：Commitizen
Commitizen 是一個(gè)幫助我們編寫(xiě)規(guī)范 commit message 的工具；
1.安裝Commitizen
npm install commitizen -D
2.安裝cz-conventional-changelog，并且初始化cz-conventional-changelog：
npx commitizen init cz-conventional-changelog --save-dev --save-exact
這個(gè)命令會(huì)幫助我們安裝cz-conventional-changelog：
并且在package.json中進(jìn)行配置：
這個(gè)時(shí)候我們提交代碼需要使用?npx cz：
第一步是選擇type，本次更新的類型
Type作用
feat新增特性 (feature)
fix修復(fù) Bug(bug fix)
docs修改文檔 (documentation)
style代碼格式修改(white-space, formatting, missing semi colons, etc)
refactor代碼重構(gòu)(refactor)
perf改善性能(A code change that improves performance)
test測(cè)試(when adding missing tests)
build變更項(xiàng)目構(gòu)建或外部依賴（例如 scopes: webpack、gulp、npm 等）
ci更改持續(xù)集成軟件的配置文件和 package 中的 scripts 命令，例如 scopes: Travis, Circle 等
chore變更構(gòu)建流程或輔助工具(比如更改測(cè)試環(huán)境)
revert代碼回退
第二步選擇本次修改的范圍（作用域）
第三步選擇提交的信息
第四步提交詳細(xì)的描述信息
第五步是否是一次重大的更改
第六步是否影響某個(gè)open issue
我們也可以在scripts中構(gòu)建一個(gè)命令來(lái)執(zhí)行 cz：
1.5.2. 代碼提交驗(yàn)證
如果我們按照cz來(lái)規(guī)范了提交風(fēng)格，但是依然有同事通過(guò)?git commit?按照不規(guī)范的格式提交應(yīng)該怎么辦呢？
我們可以通過(guò)commitlint來(lái)限制提交；
1.安裝 @commitlint/config-conventional 和 @commitlint/cli
npm i @commitlint/config-conventional @commitlint/cli -D
2.在根目錄創(chuàng)建commitlint.config.js文件，配置commitlint
module.exports = {extends: ['@commitlint/config-conventional']}
3.使用husky生成commit-msg文件，驗(yàn)證提交信息：
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
二. 第三方庫(kù)集成
2.1. vue.config.js配置
vue.config.js有三種配置方式：
方式一：直接通過(guò)CLI提供給我們的選項(xiàng)來(lái)配置：
比如publicPath：配置應(yīng)用程序部署的子目錄（默認(rèn)是?/，相當(dāng)于部署在?https://www.my-app.com/）；
比如outputDir：修改輸出的文件夾；
方式二：通過(guò)configureWebpack修改webpack的配置：
可以是一個(gè)對(duì)象，直接會(huì)被合并；
可以是一個(gè)函數(shù)，會(huì)接收一個(gè)config，可以通過(guò)config來(lái)修改配置；
方式三：通過(guò)chainWebpack修改webpack的配置：
是一個(gè)函數(shù)，會(huì)接收一個(gè)基于webpack-chain的config對(duì)象，可以對(duì)配置進(jìn)行修改；
constpath =require('path')module.exports = {outputDir:'./build',// configureWebpack: {//? resolve: {//? ? alias: {//? ? ? views: '@/views'//? ? }//? }// }// configureWebpack: (config) => {//? config.resolve.alias = {//? ? '@': path.resolve(__dirname, 'src'),//? ? views: '@/views'//? }// },chainWebpack:(config) =>{? ? config.resolve.alias.set('@', path.resolve(__dirname,'src')).set('views','@/views')? }}
2.2. vue-router集成
安裝vue-router的最新版本：
npm install vue-router@next
創(chuàng)建router對(duì)象：
import{ createRouter, createWebHashHistory }from'vue-router'import{ RouteRecordRaw }from'vue-router'constroutes: RouteRecordRaw[] = [? {path:'/',redirect:'/main'},? {path:'/main',component:() =>import('../views/main/main.vue')? },? {path:'/login',component:() =>import('../views/login/login.vue')? }]constrouter = createRouter({? routes,history: createWebHashHistory()})exportdefaultrouter
安裝router：
importrouterfrom'./router'createApp(App).use(router).mount('#app')
在App.vue中配置跳轉(zhuǎn)：
2.3. vuex集成
安裝vuex：
npm install vuex@next
創(chuàng)建store對(duì)象：
import{ createStore }from'vuex'conststore = createStore({state(){return{name:'coderwhy'}? }})exportdefaultstore
安裝store：
createApp(App).use(router).use(store).mount('#app')
在App.vue中使用：
{{ $store.state.name }}
2.4. element-plus集成
Element Plus，一套為開(kāi)發(fā)者、設(shè)計(jì)師和產(chǎn)品經(jīng)理準(zhǔn)備的基于 Vue 3.0 的桌面端組件庫(kù)：
相信很多同學(xué)在Vue2中都使用過(guò)element-ui，而element-plus正是element-ui針對(duì)于vue3開(kāi)發(fā)的一個(gè)UI組件庫(kù)；
它的使用方式和很多其他的組件庫(kù)是一樣的，所以學(xué)會(huì)element-plus，其他類似于ant-design-vue、NaiveUI、VantUI都是差不多的；
安裝element-plus
npm install element-plus
2.4.1. 全局引入
一種引入element-plus的方式是全局引入，代表的含義是所有的組件和插件都會(huì)被自動(dòng)注冊(cè)：
importElementPlusfrom'element-plus'import'element-plus/lib/theme-chalk/index.css'importrouterfrom'./router'importstorefrom'./store'createApp(App).use(router).use(store).use(ElementPlus).mount('#app')
2.4.2. 局部引入
也就是在開(kāi)發(fā)中用到某個(gè)組件對(duì)某個(gè)組件進(jìn)行引入：
<template>
? <div id="app">
? ? <router-link to="/login">登錄</router-link>
? ? <router-link to="/main">首頁(yè)</router-link>
? ? <router-view></router-view>
? ? <h2>{{ $store.state.name }}</h2>
? ? <el-button>默認(rèn)按鈕</el-button>
? ? <el-button type="primary">主要按鈕</el-button>
? ? <el-button type="success">成功按鈕</el-button>
? ? <el-button type="info">信息按鈕</el-button>
? ? <el-button type="warning">警告按鈕</el-button>
? ? <el-button type="danger">危險(xiǎn)按鈕</el-button>
? </div>
</template>
<script lang="ts">
import { defineComponent } from 'vue'
import { ElButton } from 'element-plus'
export default defineComponent({
? name: 'App',
? components: {
? ? ElButton
? }
})
</script>
<style lang="less">
</style>
但是我們會(huì)發(fā)現(xiàn)是沒(méi)有對(duì)應(yīng)的樣式的，引入樣式有兩種方式：
全局引用樣式（像之前做的那樣）；
局部引用樣式（通過(guò)babel的插件）；
1.安裝babel的插件：
npm install babel-plugin-import -D
2.配置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']}
但是這里依然有個(gè)弊端：
這些組件我們?cè)诙鄠€(gè)頁(yè)面或者組件中使用的時(shí)候，都需要導(dǎo)入并且在components中進(jìn)行注冊(cè)；
所以我們可以將它們?cè)谌肿?cè)一次；
import{? ElButton,? ElTable,? ElAlert,? ElAside,? ElAutocomplete,? ElAvatar,? ElBacktop,? ElBadge,}from'element-plus'constapp = createApp(App)constcomponents = [? ElButton,? ElTable,? ElAlert,? ElAside,? ElAutocomplete,? ElAvatar,? ElBacktop,? ElBadge]for(constcpnofcomponents) {? app.component(cpn.name, cpn)}
2.5. axios集成
安裝axios：
npm install axios
封裝axios：
importaxios, { AxiosInstance, AxiosRequestConfig, AxiosResponse }from'axios'import{ Result }from'./types'import{ useUserStore }from'/@/store/modules/user'classHYRequest{privateinstance: AxiosInstanceprivatereadonlyoptions: AxiosRequestConfigconstructor(options: AxiosRequestConfig){this.options = optionsthis.instance = axios.create(options)this.instance.interceptors.request.use((config) =>{consttoken = useUserStore().getTokenif(token) {? ? ? ? ? config.headers.Authorization =`Bearer${token}`}returnconfig? ? ? },(err) =>{returnerr? ? ? }? ? )this.instance.interceptors.response.use((res) =>{// 攔截響應(yīng)的數(shù)據(jù)if(res.data.code ===0) {returnres.data.data? ? ? ? }returnres.data? ? ? },(err) =>{returnerr? ? ? }? ? )? }? request(config: AxiosRequestConfig):Promise?{returnnewPromise((resolve, reject) =>{this.instance? ? ? ? .request>>(config)? ? ? ? .then((res) =>{? ? ? ? ? resolve((resasunknown)asPromise)? ? ? ? })? ? ? ? .catch((err) =>{? ? ? ? ? reject(err)? ? ? ? })? ? })? }? get(config: AxiosRequestConfig):Promise?{returnthis.request({ ...config,method:'GET'})? }? post(config: AxiosRequestConfig):Promise?{returnthis.request({ ...config,method:'POST'})? }? patch(config: AxiosRequestConfig):Promise?{returnthis.request({ ...config,method:'PATCH'})? }delete(config: AxiosRequestConfig):Promise?{returnthis.request({ ...config,method:'DELETE'})? }}exportdefaultHYRequest
2.6. 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}}
三. 接口文檔
https://documenter.getpostman.com/view/12387168/TzsfmQvw
baseURL的值：
http://152.136.185.210:5000
設(shè)置全局token的方法：
constres = pm.response.json();pm.globals.set("token", res.data.token);
