使用eslint統(tǒng)一代碼風(fēng)格

最近時間比較多嚼黔,研究了一下公司項目中的代碼细层,發(fā)現(xiàn)項目的編碼風(fēng)格并不統(tǒng)一,運算符前面空格的唬涧,運算符前面不空格的疫赎,用tab的,用空格鍵的碎节,注釋也寫的及其不規(guī)范捧搞,忍不了,所以想借助eslint來統(tǒng)一一下編程風(fēng)格狮荔,提高公司代碼的一致性胎撇。

什么是eslint

ESLint最初是由Nicholas C. Zakas 于2013年6月創(chuàng)建的開源項目。它的目標(biāo)是提供一個插件化的javascript代碼檢測工具殖氏。借助eslint晚树,我們可以統(tǒng)一代碼風(fēng)格,讓整個項目的編程風(fēng)格保持一致受葛。

如何使用eslint

關(guān)于如何學(xué)習(xí)eslint题涨,推薦直接看官網(wǎng):eslint。官網(wǎng)對于如何安裝总滩,如何配置已經(jīng)介紹的很仔細(xì)了,我就不再狗尾續(xù)貂了巡雨。
一般推薦使用eslint init命令生成配置文件闰渔,然后根據(jù)自己的習(xí)慣,選擇生成自己自定義的代碼風(fēng)格配置還是大公司里面的配置铐望。生成配置文件后冈涧,如果我們想對代碼規(guī)則修改,可以在rules里面加上自己的配置正蛙。

"rules": {
        "no-console":0
}

比如我的配置文件規(guī)則引用的是一個現(xiàn)在比較流行的規(guī)則督弓,其中有一條就是不允許出現(xiàn)console,但是我個人比較喜歡用console.log調(diào)試,所以我將這條規(guī)則關(guān)閉了乒验∮匏恚總而言之,eslint的規(guī)則是完全可以自定義的锻全。

js-doc風(fēng)格的注釋

JSDoc 根據(jù) JavaScript 代碼中的特殊格式的注釋生成應(yīng)用程序接口(API)文檔狂塘。例如录煤,下面的是一個函數(shù)的 JSDoc 注釋:

/**
 * Add two numbers.
 * @param {number} num1 The first number.
 * @param {number} num2 The second number.
 * @returns {number} The sum of the two numbers.
 */
function add(num1, num2) {
    return num1 + num2;
}

在第一眼看到這個注釋的時候就有一股親切感,這不是C#里面的summary嘛荞胡,瞬間愛上妈踊。趕快找在webstrom里面怎么生成這種風(fēng)格的注釋,發(fā)現(xiàn)只要輸入/**然后按enter就可以了泪漂,不愧是webstrom廊营,啥都有。

在webstrom中使用eslint

使用npm安裝好eslint后萝勤,選擇File | Settings | Languages & Frameworks | JavaScript | Code Quality Tools | ESLint赘风。一般安裝好以后,webstrom會自動的尋找eslint所在的目錄纵刘,并不需要我們手動的去配置邀窃,具體配置可參考下圖。

webstrom-eslint.png
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末假哎,一起剝皮案震驚了整個濱河市瞬捕,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌舵抹,老刑警劉巖肪虎,帶你破解...
    沈念sama閱讀 217,406評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異惧蛹,居然都是意外死亡扇救,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評論 3 393
  • 文/潘曉璐 我一進店門香嗓,熙熙樓的掌柜王于貴愁眉苦臉地迎上來迅腔,“玉大人,你說我怎么就攤上這事靠娱〔琢遥” “怎么了?”我有些...
    開封第一講書人閱讀 163,711評論 0 353
  • 文/不壞的土叔 我叫張陵像云,是天一觀的道長锌雀。 經(jīng)常有香客問我,道長迅诬,這世上最難降的妖魔是什么腋逆? 我笑而不...
    開封第一講書人閱讀 58,380評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮侈贷,結(jié)果婚禮上惩歉,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好柬泽,可當(dāng)我...
    茶點故事閱讀 67,432評論 6 392
  • 文/花漫 我一把揭開白布慎菲。 她就那樣靜靜地躺著,像睡著了一般锨并。 火紅的嫁衣襯著肌膚如雪露该。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,301評論 1 301
  • 那天第煮,我揣著相機與錄音解幼,去河邊找鬼。 笑死包警,一個胖子當(dāng)著我的面吹牛撵摆,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播害晦,決...
    沈念sama閱讀 40,145評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼特铝,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了壹瘟?” 一聲冷哼從身側(cè)響起鲫剿,我...
    開封第一講書人閱讀 39,008評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎稻轨,沒想到半個月后灵莲,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,443評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡殴俱,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,649評論 3 334
  • 正文 我和宋清朗相戀三年政冻,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片线欲。...
    茶點故事閱讀 39,795評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡明场,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出询筏,到底是詐尸還是另有隱情榕堰,我是刑警寧澤,帶...
    沈念sama閱讀 35,501評論 5 345
  • 正文 年R本政府宣布嫌套,位于F島的核電站,受9級特大地震影響圾旨,放射性物質(zhì)發(fā)生泄漏踱讨。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,119評論 3 328
  • 文/蒙蒙 一砍的、第九天 我趴在偏房一處隱蔽的房頂上張望痹筛。 院中可真熱鬧,春花似錦、人聲如沸帚稠。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽滋早。三九已至榄审,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間杆麸,已是汗流浹背搁进。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留昔头,地道東北人饼问。 一個月前我還...
    沈念sama閱讀 47,899評論 2 370
  • 正文 我出身青樓,卻偏偏與公主長得像揭斧,于是被迫代替她去往敵國和親莱革。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,724評論 2 354

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理讹开,服務(wù)發(fā)現(xiàn)盅视,斷路器,智...
    卡卡羅2017閱讀 134,654評論 18 139
  • ESLint 配置 ESlint 被設(shè)計為完全可配置的萧吠,這意味著你可以關(guān)閉每一個規(guī)則而只運行基本語法驗證左冬,或混合和...
    靜默虛空閱讀 41,295評論 3 14
  • EsLint入門學(xué)習(xí)整理 這兩天因為公司要求,就對ESLint進行了初步的了解纸型,網(wǎng)上的內(nèi)容基本上都差不多拇砰,但是內(nèi)容...
    點柈閱讀 26,023評論 3 42
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,110評論 25 707
  • 13年四月份荷蘭牛欄諾優(yōu)能伴隨著一個網(wǎng)易博客上的黑化帖正式登陸。13年十一月雙11當(dāng)天天貓諾優(yōu)能旗艦店單店總銷量破...
    8j0z閱讀 1,640評論 2 3