VUE中集成editorconfig配置并使用prettier和ESLint

当我们在创建一个项目时，如果需要统一开发风格保持代码的一致性，这时就需要我们在项目中配置一些东西，首先是集成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

VSCode需要安装一个插件：EditorConfig for VS Code

使用prettier工具

1.安装prettier

npm install prettier -D

2.配置.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.VSCode需要安装prettier的插件

如果没用生效，可能是因为没用配置保存格式化或者默认的格式化插件太多

• 文件--首选项--设置--搜索save--格式化

• 选中Editor: Format On Save

• 文件中 右键 格式化文档 配置默认的格式化插件

• 5.测试prettier是否生效

• 测试一：在代码中保存代码；

• 测试二：配置一次性修改的命令；

       在package.json中配置一个scripts：

"prettier": "prettier --write ."

全部打包：

	npm run prettier

3. 使用ESLint检测

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

2.VSCode需要安装ESLint插件：ESLint

3.解决eslint和prettier冲突的问题：安装插件：（vue在创建项目时，如果选择prettier，那么这两个插件会自动安装）

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

.eslintrc.js中添加prettier插件：

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

重启一下vs code

如果.eslintrc.js文件缩进有问题， eslint和prettier冲突，可以试试在settings.json中配置一下

 // 配置全局 eslint 配置
  "eslint.options": {
    "configFile": "F:\\devFiles\\devToolsSettings\\.eslintrc.js"
  }