一、.editorconfig檔案是什麼？

在專案裡，大多時候都能看到.editorconfig檔案，剛開始總是忽視掉它，認為它不太重要。但是，它的存在，必定有它的理由，於是，抽空來研究一下，它是什麼，能做什麼。

 官網是這麼介紹EditorConfig的，“EditorConfig幫助開發人員在不同的編輯器和IDE之間定義和維護一致的編碼樣式。EditorConfig專案由用於定義編碼樣式的檔案格式和一組文字編輯器外掛組成，這些外掛使編輯器能夠讀取檔案格式並遵循定義的樣式。EditorConfig檔案易於閱讀，並且與版本控制系統配合使用。”

不同的開發人員，不同的編輯器，有不同的編碼風格，而EditorConfig就是用來協同團隊開發人員之間的程式碼的風格及樣式規範化的一個工具，而.editorconfig正是它的預設配置檔案。

二、示例檔案

# 告訴EditorConfig外掛，這是根檔案，不用繼續往上查詢
root = true

# 匹配全部檔案
[*]
# 結尾換行符，可選"lf"、"cr"、"crlf"
end_of_line = lf
# 在檔案結尾插入新行
insert_final_newline = true
# 刪除一行中的前後空格
trim_trailing_whitespace = true
# 匹配js和py結尾的檔案
[*.{js,py}]
# 設定字符集
charset = utf-8

# 匹配py結尾的檔案
[*.py]
# 縮排風格，可選"space"、"tab"
indent_style 
 
= space
# 縮排的空格數
indent_size = 4

# 以下匹配，類同
[Makefile]
indent_style = tab
# tab的寬度
tab_width = 4

# 以下匹配，類同
[lib/**.js]
indent_style = space
indent_size = 2

[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

三、注意事項、配置說明

1、如果是windows使用者，如果無法建立.editorconfig檔案，則需要先建立.editorconfig.檔案，系統會自動重新命名成.editorconfig檔案。

2、EditorConfig的匹配規則是從上往下，即先定義的規則優先順序比後定義的優先順序要高。

3、外掛安裝，在GitHub上已經有了各種流行編輯器的外掛原始碼，可根據說明安裝。

4、對於VS Core，對應的外掛名是EditorConfig for VS Code。

5、這裡列舉了VS Code支援的規則：

• indent_style
• indent_size
• tab_width
• end_of_line
• insert_final_newline
• trim_trailing_whitespace

 四、寫在最後

總體上來說，EditorConfig的配置還比較簡單，官網的文件也不難理解，使用起來，真心不錯，值得推薦。