editorConfig編輯器配置

????????當(dāng)多人團隊進行一個項目開發(fā)時,每個人可能喜歡的編輯器不同辛辨,有人喜歡Webstrom、有人喜歡sublime瑟枫、還有人喜歡Hbuilder斗搞。

????????這個時候,問題便迎面而來慷妙,如何使使用不同編輯器的開發(fā)者能夠輕松愜意的遵守最基本的代碼規(guī)范呢僻焚?

? ? ????最后終于找到了editorConfig這個東東,發(fā)現(xiàn)在這里配置的代碼規(guī)范規(guī)則優(yōu)先級高于編輯器默認的代碼格式化規(guī)則膝擂。比如我使用的是Webstrom編輯器虑啤,我每一次寫完代碼之后隙弛,都習(xí)慣性的按下“Ctrl+Alt+L”快捷鍵去整理代碼格式。如果我沒有配置editorconfig咐旧,執(zhí)行的就是編輯器默認的代碼格式化規(guī)則驶鹉;如果我已經(jīng)配置了editorConfig,則按照我設(shè)置的規(guī)則來铣墨,從而忽略瀏覽器的設(shè)置室埋。

????????EditorConfig包含一個用于定義代碼格式的文件和一批編輯器插件,這些插件是讓編輯器讀取配置文件并以此來格式化代碼伊约。

? ? ????下面說說它的常用配置和使用方法:

????????一姚淆、常用屬性配置

? ??????????1、root<boolean>

? ? ? ? ? ? ? ? ?是否是頂級配置文件屡律,設(shè)置為true的時候才會停止搜索.editorconfig文件

? ??????????2腌逢、charset<"latin" | "utf-8" | "utf-8-bom" | "utf-16be" | "utf-16le">

? ? ? ? ? ? ? ? ?編碼格式

? ??????????3、indent_style<"tab" | "space">

? ? ? ? ? ? ? ? ?縮進方式

????????????4超埋、indent_size<number>

? ? ? ? ? ? ? ? ?縮進大小

? ??????????5搏讶、end_of_line<"lf" | "cr" | "crlf">

? ? ? ? ? ? ? ? ?換行符類型

? ??????????6、insert_final_newline<boolean>

? ? ? ? ? ? ? ? ?是否讓文件以空行結(jié)束

? ??????????7霍殴、trim_trailing_whitespace<boolean>

? ? ? ? ? ? ? ? ?是否刪除行尾空格

? ??????????8媒惕、max_line_length<number>

? ? ? ? ? ? ? ? ?最大行寬。

????????二来庭、常用文件名匹配

? ??????????1妒蔚、*?

? ? ? ? ? ? ? ? ?匹配除/之外的任意字符

????????????2、**

? ? ? ? ? ? ? ? ?匹配任意字符串

? ??????????3月弛、?

? ? ? ? ? ? ? ? ?匹配任意單個字符

????????????4肴盏、[name]

? ? ? ? ? ? ? ? ?匹配name字符

? ??????????5、[!name]

? ? ? ? ? ? ? ? ?不匹配name字符

????????????6帽衙、[s1,s2,s3]

? ? ? ? ? ? ? ? ?匹配給定的字符串

? ??????????7菜皂、[num1..num2]

? ? ? ? ? ? ? ? ?匹配num1到mun2直接的整數(shù)

????????三、使用方法

? ? ? ? ? ? ?1厉萝、下載編輯器的相關(guān)插件恍飘。

? ? ? ? ? ? ?2、在項目根目錄下冀泻,新建.editorconfig文件常侣。

? ? ? ? ? ? ?3、配置示例弹渔,如下圖所示:

.editorconfig內(nèi)容示例

????????四胳施、參考網(wǎng)站

? ? ? ? ? ? ?EditorConfig官網(wǎng):https://editorconfig.org

? ? ? ? ? ? ?Atom網(wǎng)站:https://atom.io/packages/editorconfig

? ? ? ? ? ? ?GitHub:https://github.com/sindresorhus/atom-editorconfig

????????五、使用建議

? ? ? ? ? ? ? 配合代碼檢查工具使用肢专,比如說:ESLint或TSLint舞肆,統(tǒng)一代碼風(fēng)格焦辅。

????????六、支持的編輯器


支持的編輯器

????????雖然editor編輯器的可用配置并不多椿胯,但目前現(xiàn)有的一些配置也差不多能滿足最基本格式需求筷登。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
禁止轉(zhuǎn)載,如需轉(zhuǎn)載請通過簡信或評論聯(lián)系作者哩盲。
  • 序言:七十年代末前方,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子廉油,更是在濱河造成了極大的恐慌惠险,老刑警劉巖,帶你破解...
    沈念sama閱讀 207,248評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件抒线,死亡現(xiàn)場離奇詭異班巩,居然都是意外死亡,警方通過查閱死者的電腦和手機嘶炭,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,681評論 2 381
  • 文/潘曉璐 我一進店門抱慌,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人眨猎,你說我怎么就攤上這事抑进。” “怎么了宵呛?”我有些...
    開封第一講書人閱讀 153,443評論 0 344
  • 文/不壞的土叔 我叫張陵单匣,是天一觀的道長夕凝。 經(jīng)常有香客問我宝穗,道長,這世上最難降的妖魔是什么码秉? 我笑而不...
    開封第一講書人閱讀 55,475評論 1 279
  • 正文 為了忘掉前任逮矛,我火速辦了婚禮,結(jié)果婚禮上转砖,老公的妹妹穿的比我還像新娘须鼎。我一直安慰自己,他們只是感情好府蔗,可當(dāng)我...
    茶點故事閱讀 64,458評論 5 374
  • 文/花漫 我一把揭開白布晋控。 她就那樣靜靜地躺著,像睡著了一般姓赤。 火紅的嫁衣襯著肌膚如雪赡译。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,185評論 1 284
  • 那天不铆,我揣著相機與錄音蝌焚,去河邊找鬼裹唆。 笑死,一個胖子當(dāng)著我的面吹牛只洒,可吹牛的內(nèi)容都是我干的许帐。 我是一名探鬼主播,決...
    沈念sama閱讀 38,451評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼毕谴,長吁一口氣:“原來是場噩夢啊……” “哼成畦!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起涝开,我...
    開封第一講書人閱讀 37,112評論 0 261
  • 序言:老撾萬榮一對情侶失蹤羡鸥,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后忠寻,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體惧浴,經(jīng)...
    沈念sama閱讀 43,609評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,083評論 2 325
  • 正文 我和宋清朗相戀三年奕剃,在試婚紗的時候發(fā)現(xiàn)自己被綠了衷旅。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,163評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡纵朋,死狀恐怖柿顶,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情操软,我是刑警寧澤嘁锯,帶...
    沈念sama閱讀 33,803評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站聂薪,受9級特大地震影響家乘,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜藏澳,卻給世界環(huán)境...
    茶點故事閱讀 39,357評論 3 307
  • 文/蒙蒙 一仁锯、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧翔悠,春花似錦业崖、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,357評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至撮抓,卻和暖如春妇斤,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,590評論 1 261
  • 我被黑心中介騙來泰國打工趟济, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留乱投,地道東北人。 一個月前我還...
    沈念sama閱讀 45,636評論 2 355
  • 正文 我出身青樓顷编,卻偏偏與公主長得像戚炫,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子媳纬,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,925評論 2 344