[TOC] #### 1. 情景 --- EditorConfig 官网：<https://editorconfig.org> 项目中经常会进行多人开发，而且很可能使用不同的编辑器，很容易就会造成代码格式不统一 EditorConfig 就是专门同来解决这个问题的，可以统一开发者的编码规范，多人开发时非常有用的插件 #### 2. 用法 --- **第一步：安装插件** 首先，先去官网查看当前使用的编辑器是否自带 EditorConfig 支持，编辑器本身支持则无需另外下载插件 以 VSCode 为例，需要下载插件 [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) 才可以使用 EditorConfig 格式化代码，[点击查看插件用法](https://www.itqaq.com/index/621.html) **第二步：创建 .editorconfig 文件** ``` # 告诉 EditorConfig 插件，这是根文件，不用继续往上查找 root = true [*] # 所有文件生效 charset = utf-8 # 设置字符集 indent_style = space # 空格缩进，可选 "spac"、"tab" indent_size = 2 # 缩进的空格数 end_of_line = lf # 结尾换行符，可选 "lf"、"cr"、"crlf" insert_final_newline = true # 在文件结尾插入新行 trim_trailing_whitespace = true # 删除一行中的前后空格 [*.md] # 匹配 md 文件 insert_final_newline = false # 在文件结尾插入新行 trim_trailing_whitespace = false # 删除一行中的前后空格 ``` #### 3. 运行机制 --- 当打开一个文件时，EditorConfig 插件会从文件所在目录和其每一级父目录查找 `.editorconfig` 文件 直到文件中有 `root = true` 会停止查找，最近的配置文件中的配置项优先使用，未设置的配置项，会使用插件的默认配置