1.配置项目环境

使用npm搭建项目

 npm init vue@latest

添加依赖

 npm install

启动项目

 npm run dev

安装volar和volar+TS插件

修改env.d.ts文件，配置vue文件模块

 declare module '*.vue' {
   import { DefineComponent } from 'vue'
   const component: DefineComponent
   export default component
 }

2.配置代码规范

2.1 配置.editorconfig文件

EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。

 # http://editorconfig.org
 
 root = true
 
 [*] # 表示所有文件适用
 charset = utf-8 # 设置文件字符集为 utf-8
 indent_style = space # 缩进风格（tab | space）
 indent_size = 2 # 缩进大小
 end_of_line = lf # 控制换行类型(lf | cr | crlf)
 trim_trailing_whitespace = true # 去除行尾的任意空白字符
 insert_final_newline = true # 始终在文件末尾插入一个新行
 
 [*.md] # 表示仅 md 文件适用以下规则
 max_line_length = off
 trim_trailing_whitespace = false

VSCode安装以下插件(用于读取.editorconfig文件)

2.2 配置prettier工具

1.安装prettier

 npm install prettier -D

2.配置.prettierrc文件

 {
   "useTabs": false,
   "tabWidth": 2,
   "printWidth": 100,
   "singleQuote": true,
   "trailingComma": "none",
   "semi": false
 }

useTabs：使用tab缩进还是空格缩进，选择false；
tabWidth：tab是空格的情况下，是几个空格，选择2个；
printWidth：当行字符的长度是100；
singleQuote：使用单引号还是双引号，选择true，使用单引号；
trailingComma：在多行输入的尾逗号是否添加，设置为 none，比如对象类型的最后一个属性后面是否加一个，；
semi：语句末尾是否要加分号，默认值true，选择false表示不加；

3.配置.prettierignore忽略文件

 /dist/*
 .local
 .output.js
 /node_modules/**
 
 **/*.svg
 **/*.sh
 
 /public/*

4.VSCode需要安装prettier的插件

5.VSCod中的配置

settings =>format on save => 勾选上

settings => editor default format => 选择 prettier

6.在package.json中配置一个scripts

 "prettier": "prettier --write ."

2.3 配置ESLint检测工具

1.ESLint环境

在前面创建项目的时候，我们就选择了ESLint，所以Vue会默认帮助我们配置需要的ESLint环境。

2.VSCode需要安装ESLint插件

3.解决eslint和prettier冲突的问题

安装插件：（vue在创建项目时，如果选择prettier，那么这两个插件会自动安装）

 npm install eslint-plugin-prettier eslint-config-prettier -D

添加prettier插件：

 // 配置.eslintrc.cjs文件
 extends: [
     ...
     'plugin:prettier/recommended',
     ...
   ],

3. Husky工具

husky是一个git hook工具，可以帮助我们触发git提交的各个阶段：pre-commit、commit-msg、pre-push，可以很好的改善提交到git上的不规范代码的情况。

3.1 下载husky依赖

前提是此项目有对应的git仓库(若没有先用git init命令初始化一个仓库)

 npx husky-init && npm install

下载完之后会出现：

package.json文件中有相应的依赖

3.2 配置.husky文件夹下的pre-commit文件

 npm run lint

此时在执行git commit命令后，husky会自动执行eslint检测工具，及时修改不规范的代码。

Vite搭建Vue3+TS项目的环境配置