搭建后台管理系统模板分为两大步骤：
- 项目初始化
- 项目配置
项目初始化
环境准备
- node：v16.16.0
- pnpm：v7.22.0
初始化项目
全局安装pnpm指令：
npm i -g pnpm
项目初始化指令：
pnpm create vite
如下图所示进行项目的选项设置：
使用vscode打开创建好的项目，依次运行指令：
pnpm install //安装依赖
pnpm run dev //运行项目
在vscode终端得到如下图所示的结果，点击http://127.0.0.1:5173链接，浏览器中即可得到相应的项目界面
此时项目初始化步骤已完成
项目配置
一个项目要有统一的规范，需要使用eslint+stylelint+prettier来对我们的代码质量做检测和修复，使用husky来做commit拦截，使用commitlint来统一代码提交规范，使用preinstall统一包管理工具
其中，eslint用于代码语法检测；stylelint用于对css代码进行语法检测；prettier用于代码格式规范；husky用于commit拦截，在代码提交前自动对代码进行格式化；commitlint规范代码提交时的信息；preinstall统一包管理器工具
eslint 配置
ESLint 提供一个插件化的 JS 代码检测工具
安装 eslint 指令：
pnpm i eslint -D
生成配置文件 .eslint.cjs 指令：
npx eslint --init
选项配置如下图所示：
在生成的.eslintrc.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 int 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": {
}
}
安装 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 -D eslint-plugin-import eslint-plugin-vue eslint-plugin-node eslint-plugin-prettier eslint-config-prettier eslint-plugin-node @babel/eslint-parser
接着修改.eslintrc.cjs文件如下：
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: {
'no-var': 'error', //要求使用 let 或 const 而不是 var
'no-multiple-empty-lines': ['warn', { max: 1 }], //不允许多个空行
'no-console': precess.env.NODE_ENV === 'production' ? 'error' : 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
'no-unexpected-multiline': 'error', //禁止空余的多行
'no-useless-escape': 'off', //禁止不必要的转义字符
'@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',
'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', // 对模板中的自定义组件强制执行属性命名样式
}
}
创建.eslintingore配置文件：
dist
node_modules
在package.json文件中新增两个运行脚本
"scripts": {
"lint": "eslint src",
"fix": "eslint src --fix",
}
到此eslint的相关配置结束
prettier 配置
eslint针对的是 JS，它是一个检测工具，包含 JS 语法以及少部分格式问题，在eslint看来，语法对了就能保证代码正常运行，格式问题属于其次
prettier属于格式化工具，它看不惯格式不统一
总结起来，eslint保证代码质量，prettier保证代码美观
安装依赖包指令：
pnpm install -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/*
通过pnpm run lint指令检测语法，如果出现不规范格式，就通过pnpm run fix修改
stylelint 配置
stylelint为css的lint工具，可格式化css代码，检查css代码错误与不合理的写法，指定css书写顺序等
项目中使用scss作为预处理器，安装依赖指令：
pnpm add sass sass-loader stylelint postcss 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配置文件：
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',
},
],
// 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, //关闭强制选择器类名的格式
'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默认样式的时候能使用到
}
]
}
}
添加.stylelintignore文件：
/node_modules/*
/dist/*
/html/*
/public/*
添加运行脚本，配置统一的prettier来格式化 js、css和html代码：
"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"
}
到此stylelint的相关配置结束
husky 配置
上述步骤已经集成了代码校验工具，此时需要手动执行运行脚本才会格式化我们的代码，如果有人没有格式化代码就将其提交到远程仓库中，我们缩写的规范就无法起到作用，所以我们需要强制让开发人员按照代码规范来提交
要实现此目标，就需要利用husky在代码提交前触发git hook（git在客户端的钩子），然后执行pnpm run format来自动的格式化代码
先创建远程仓库，如下图所示：
然后使用git clone指令将远程仓库克隆到本地，随后将初始化的项目中的所有文件复制到本地仓库中
安装husky指令：
pnpm install -D husky
执行如下指令：
npx husky-init
此时会在根目录下生成一个.husky目录，在这个目录下会有一个pre-commit文件，这个文件里面的命令在我们执行commit的时候就会执行
在./husky/pre-commit文件添加如下命令：
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
pnpm run format
当我们对代码进行commit操作的时候，就会执行命令，对代码进行格式化，然后再提交
commitlint 配置
对于我们的commit信息，也是有统一规范的，不能随便写，要让每个人都按照统一的标准来执行，我们可以利用 commitlint 来实现
安装指令如下：
pnpm add @commitlint/config-conventional @commitlint/cli -D
添加commitlint.config.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": {
"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"符合类型的才可以，需要注意的是，类型的后面需要使用英文的:，并且冒号后面需要有一个空格
强制使用pnpm包管理器工具
团队开发项目的时候，需要统一包管理器工具，因为不同包管理器工具下载同一个依赖，可能版本不一样。
导致项目出现bug问题，因此包管理器工具需要统一管理！！！
在根目录创建scripts/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提供的生命周期钩子）这个文件里面的代码。
