【Vue3+TypeScript】CRM系统项目搭建之 — 代码规范

🐼 集成editorconfig配置

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

以 WebStrom 为例，安装 Editorconfig 插件

此时需要在项目根目录下新建配置文件 .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

🐼 使用 prettier 工具

可以看到 prettier 可以翻译成 漂亮：

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

安装 prettier

npm install prettier -D

配置.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
}

创建.prettierignore忽略文件

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

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

/public/*

安装prettier的插件

在webstorm上如何配置prettier？

🐼 使用 Eslint 进行代码检测

1. 在前面创建项目的时候，我们就选择了ESLint，所以Vue会默认帮助我们配置需要的ESLint环境。
   
2. 进行一些配置
   
   
3. 解决eslint和prettier冲突的问题：

什么是冲突问题呢？比如在 prettier 中规定在代码保存的时候自动格式化代码，使得所有得单引号变为双引号，但是我们在 eslint 中规定的是，不可以是双引号。这就不符合 eslint 的规范了。

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

npm install 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'
  ],

完成如上配置之后，当代码保存的时候，eslint 就会按照 pretter 里面的这个保存规范来进行代码风格检测了。

4. 自定义一些规则

这个就配置了解除对声明但未被使用的变量的警告。