Vue项目搭建及代码规范

① 选择项目需要的特性

​编辑② 具体特性条件

2、 代码规范

① 集成editorconfig配置

 完整代码：

② 使用prettier工具

 Vscode编辑器

其他编辑器

1）安装prettier

2）配置.prettierrc文件：

3）创建.prettierignore忽略文件

4）在package.json中配置一个scripts：

5）一键规范脚本

1、选择feature

① 选择项目需要的特性

② 具体特性条件

Use class-style component syntax? 

是否使用class风格的component（一般不使用）

Use Babel alongside TypeScript (required for modern mode, auto-detected polyfills, transpiling JSX)?         

是否使用Babel来处理TypeScript（官方文档建议最好使用Babel）

Pick a CSS pre-processor (PostCSS, Autoprefixer and CSS Modules are supported by default): 

选择css预处理器，看个人喜好

Pick a linter / formatter config: 

选择ESLint的模式

Pick additional lint features: 

在什么时候使用ESLint

Lint on save        - 保存时

Lint and fix on commit        - fix 或 commit时

 Where do you prefer placing config for Babel, ESLint, etc.?

生成的配置文件放单独的文件里还是统一放在package.json中

In dedicated config files        单独文件
In package.json        放在package.json中

Save this as a preset for future projects?

是否保存为预设

2、 代码规范

① 集成editorconfig配置

在工作中，一个项目可能是由多人开发的。在开发过程中，可能会出现这样一个问题。一个开发人员用的是windo系统，另一个开发人员用的是Mac系统。在不同操作系统中，同样的按键可能表示不同的功能。或是说，两个开发人员使用不同的编辑器，一个使用VScode 一个使用Webstorm。同样用Tab表示缩进，一个缩进为2 ，另一个缩进为4。代码风格不同，在仓库提交拉取后，代码会不太美观。

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

 在项目中，配置一个名为.editorconfig的文件

 完整代码：

# 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 for VS Code

② 使用prettier工具

Prettier 是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。

 Vscode编辑器

VSCode需要安装prettier的插件，即可直接使用

其他编辑器

我们还可以配置prettier这个包，这样无论项目放到哪里都可以做格式化的

1）安装prettier

npm install prettier -D

2）配置.prettierrc文件：

在当前项目目录下创建一个.prettierrc文件

• useTabs：使用tab缩进还是空格缩进，选择false；

• tabWidth：tab是空格的情况下，是几个空格，选择2个；

• printWidth：当行字符的长度，推荐80，也有人喜欢100或者120；

• singleQuote：使用单引号还是双引号，选择true，使用单引号；

• trailingComma：在多行输入的尾逗号是否添加，设置为 none；

• semi：语句末尾是否要加分号，默认值true，选择false表示不加；

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

3）创建.prettierignore忽略文件

/dist/*
.local
.output.js
/node_modules/**

**/*.svg
**/*.sh

/public/*

4）在package.json中配置一个scripts：

"prettier": "prettier --write ."

5）一键规范脚本

npm run prettier

③ 使用ESLint检测

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

Vscode编辑器

Vscode可以使用ESLint插件快速对代码进行检查

 解决eslint和prettier冲突的问题：

1）安装插件：

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

npm i eslint-plugin-prettier eslint-config-prettier -D

 2）添加prettier插件

在.eslintrc.js中，修改extends代码

extends: [
    "plugin:vue/vue3-essential",
    "eslint:recommended",
    "@vue/typescript/recommended",
    "@vue/prettier",
    "@vue/prettier/@typescript-eslint",
    'plugin:prettier/recommended'
  ],

④ 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

 这样会做三件事：

1）安装husky相关的依赖：

 2）在项目目录下创建 .husky 文件夹：

3）在package.json中添加一个脚本：

4）接下来，我们需要去完成一个操作：在进行commit时，执行lint脚本：