快速用上 editorconfig 來規範編輯

小皮草發表於2018-09-15

基本介紹

主要用於統一編輯程式碼時的風格,其中主要統一的是縮排的風格。

檔案形式

.editorconfig

是否需要外掛

有些編輯器自帶了對這個檔案的支援,無需安裝外掛。有些則需要再自行安裝相應外掛。

(VS Code 需要安裝外掛 EditorConfig for VS Code)

編輯器是否需要安裝外掛可以檢視官網列出的統計
editorconfig.org/

如何生效

在 VS Code 中,建立好檔案和安裝好外掛後,需要重啟編輯器,但是此時只是修改編輯器的編輯設定,並不會將你已經存在的程式碼進行規範,可以通過快捷鍵格式化:

shift + alt + F

配置資訊

# 表明這是最頂層的配置檔案,這樣才會停止繼續向上查詢 .editorconfig 檔案;
# 查詢的 .editorconfig 檔案是從頂層開始讀取的,類似變數作用域的效果,內部
# 的 .editorconfig 檔案屬性優先順序更高
root = true

# 指定作用檔案格式
[*]

# 縮排的型別 [space | tab]
indent_style = space

# 縮排的大小 
# tab_width: 設定整數用於指定替代tab的列數。預設值就是indent_size的值,一般無需指定。
indent_size = 2

# 定義換行符 [lf | cr | crlf]
end_of_line = lf

# 編碼格式。支援latin1、utf-8、utf-8-bom、utf-16be和utf-16le,不建議使用uft-8-bom。
charset = utf-8

# 是否除去換行行首的任意空白字元
trim_trailing_whitespace = false

# 檔案是否以一個空白行結尾 [true | false]
insert_final_newline = true
複製程式碼

相關文章