[TOC] #### 1. 情景 --- EditorConfig 官網:<https://editorconfig.org> 項目中經常會進行多人開發,而且很可能使用不同的編輯器,很容易就會造成代碼格式不統一 EditorConfig 就是專門同來解決這個問題的,可以統一開發者的編碼規范,多人開發時非常有用的插件 #### 2. 用法 --- **第一步:安裝插件** 首先,先去官網查看當前使用的編輯器是否自帶 EditorConfig 支持,編輯器本身支持則無需另外下載插件 以 VSCode 為例,需要下載插件 [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) 才可以使用 EditorConfig 格式化代碼,[點擊查看插件用法](http://www.837wan.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` 會停止查找,最近的配置文件中的配置項優先使用,未設置的配置項,會使用插件的默認配置