vue3项目+TypeScript前端项目—— vue3搭建项目+eslint+husky

今天来带大家从0开始搭建一个vue3版本的后台管理系统。一个项目要有统一的规范，需要使用eslint+stylelint+prettier来对我们的代码质量做检测和修复，需要使用husky来做commit拦截，需要使用commitlint来统一提交规范，需要使用preinstall来统一包管理工具。

下面我们就用这一套规范来初始化我们的项目，集成一个规范的模版。

1.1 环境准备

• node v16.14.2
• pnpm 8.0.0

1.2初始化项目

本项目使用vite进行构建，vite官方中文文档参考：cn.vitejs.dev/guide/

pnpm:performant npm ，意味“高性能的 npm”。pnpm由npm/yarn衍生而来，解决了npm/yarn内部潜在的bug，极大的优化了性能，扩展了使用场景。被誉为“最先进的包管理工具”

所以，我们也试一试pmpm有多好用，一起来用一用吧！

①安装pnpm

pnpm安装指令：npm i -g pnpm

②项目初始化

在指定的文件夹内新建一个文件夹，进入后运行创建项目的命令
项目初始化命令：pnpm create vite

报错了，如下：

根据错误提示信息，是由于原淘宝npm镜像地址：“ https://registry.npm.taobao.org ” 的证书失效
手动修改Dockerfile的构建指令，配置 registry 即可，将原：

RUN npm config set registry https://registry.npm.taobao.org

修改为：

RUN npm config set registry https://registry.npmmirror.com

再次运行，成功了。

③安装依赖

进入到项目根目录pnpm install安装全部依赖。

④运行程序

安装完依赖运行程序：pnpm run dev

1.3 项目配置

1.3.1 运行后自动打开浏览器

在package.json里面的dev添加--open

1.3.2 eslint配置 —— js代码质量

eslint中文官网:http://eslint.cn/

这是一个插件化的javascript代码检测工具，保证代码的质量

①首先安装eslint

pnpm i eslint -D

②生成配置文件:.eslint.cjs

npx eslint --init

运行成功，我们可以看到项目的根路径会多一个.eslintrc.cjs的文件

③详看.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": {
   
    }
}

④ 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配置文件

安装完第三步的插件，需要修改.eslintrc.cjs配置文件，直接拷贝下面的即可

// @see https://eslint.bootcss.com/docs/rules/

module.exports = {
   
  env: {
   
    browser: true,
    es2021: true,
    node