統一代碼風格工具 editorConfig

editorConfig簡介

按照名字解釋就是編輯器配置,能夠幫助開發者在不一樣的編輯器和IDE之間定義和維護一致的代碼風格。好比文件縮進、換行等格式。
editorConfig官網git

工做方式

通常在項目根目錄建立一個名爲 .editorconfig 的文件,該文件的內容定義該項目的編碼規範.
當用IDE打開一個文件時,editorConfig插件會在打開文件的目錄和其每一級父節點查找.editorconfig文件, 編輯器讀取配置文件並依此格式化代碼,若是沒有的話就用編輯器默認配置.github

editorConfig 例子

# http://editorconfig.org
root = true
# 對全部的文件生效
[*]
charset = utf-8
indent_style = space
indent_size = 4
tab_width =4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline= true
max_line_length = 80

[*.{json,yml}]
indent_size = 2

[*.md]
trim_trailing_whitespace = false

editorConfig 配置說明

root           表示是最頂層的配置文件,發現設爲true時,纔會中止查找.editorconfig文件    
charset           設置編碼 通常設置爲utf8
indent_style    縮進類型(tab是硬縮進,space爲軟縮進)
indent_size     縮進的數量,若是indent_style爲tab,則此屬性默認爲tab_width
tab_width        用一個整數來設置tab縮進的列數。默認是indent_size
end_of_line     換行符格式,值爲lf、cr和crlf
trim_trailing_whitespace  設爲true表示會去除換行行首的任意空白字符。
insert_final_newline      是否在文件的最後插入一個空行

以上是經常使用配置,更多的能夠參考這裏json

編輯器插件

editorConfig官網 上面已經列出各個編輯器的插件,能夠去官網下載 輸入圖片說明編輯器

參考文檔

相關文章
相關標籤/搜索