為什么應(yīng)該在你的項目中使用 EditorConfig

簡評:對于我自己來說,既有 PC 也有 Mac,并且都會有編程的需求,也會用到多種 IDE,EditorConfig 確實幫我擺脫了重復(fù)設(shè)置代碼規(guī)范這件麻煩事。

現(xiàn)在已經(jīng) 2017 年了,但還是有很多人陷入在 tabs vs spaces 之類的爭論中。不是每個人都在嚴(yán)格要求自己的代碼規(guī)范和風(fēng)格,對于多人協(xié)作的項目這容易出現(xiàn)問題,畢竟每個人所用的 IDE 和編輯器都可能不同。

這里就要介紹下 EditorConfig 了,你只需配置一個 .editorconfig 文件,在其中設(shè)置好要遵守的代碼規(guī)范,放在項目的根目錄下,就能夠在幾乎所有的主流 IDE 和編輯器中復(fù)用了,可以將 .editorconfig 文件也提交到版本控制系統(tǒng)中,就不需要針對不同 IDE 和編輯器再單獨進(jìn)行設(shè)置了。
目前無需插件直接支持的有:

![Uploading 0_957798.jpg . . .]

插件列表:EditorConfig Download a Plugin
語法也很簡單,這是一個簡單的例子:

# indicate this is the root of the project
root = true

[*]
indent_style = space
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
indent_size = 2

[*.html]
indent_size = 4
max_line_length = 80

[*.md]
trim_trailing_whitespace = false

目前支持的屬性:EditorConfig-Properties

當(dāng)然如果你使用的工具不在以上的話,可以自己開發(fā)一個插件,官方也有相應(yīng)的教程:
https://github.com/editorconfig/editorconfig/wiki/Plugin-How-To

官方網(wǎng)站:EditorConfig

目前在使用 EditorConfig 的項目已經(jīng)有包括 jQuery, LibreOffice, Node.js, Ionic 等在內(nèi)的數(shù)十個知名項目。

具體項目列表可以看看:editorconfig/projects

擴(kuò)展閱讀:
2016 開發(fā)者工具年度熱門盤點

歡迎關(guān)注

  • 知乎專欄「極光日報」,每天為 Makers 導(dǎo)讀三篇優(yōu)質(zhì)英文文章。
  • 網(wǎng)易云電臺「極光日報**」,上下班路上為你讀報。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 178,954評論 25 709
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,544評論 19 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,265評論 6 342
  • 這是我父親 日記里的文字 這是他的生命 留下 留下來的散文詩 幾十年后 我看著淚流不止 可我的父親已經(jīng)老得像一張舊...
    凌七璐閱讀 312評論 3 12

友情鏈接更多精彩內(nèi)容