Vscode結(jié)合Eslint和Prettier 實現(xiàn)團隊代碼規(guī)范有效執(zhí)行

為了項目代碼長期維護浆竭,代碼規(guī)范是技術(shù)團隊建設(shè)必須重視的一件事情泵额。規(guī)范的制定很容易,可是執(zhí)行卻一直不那么徹底犹菇。尤其是趕項目進度的時候全蝶。寫代碼的是人闹蒜,不是機器。

列舉下為了代碼規(guī)范的有效實行抑淫,我們團隊使用過的方法:

1绷落、團隊成員相互手動 code review,每周開code review 會總結(jié)始苇,僅僅堅持了兩個月砌烁;

2、vistual studio編輯器上安裝svn code review插件催式,在代碼提交的時候進行code review函喉, 可以評價每一行代碼,發(fā)給對應(yīng)的人荣月,并有任務(wù)要求每人每周必須review多少行代碼管呵。這個方法運行了很長時間,代碼規(guī)范得執(zhí)行得到了較大改善哺窄。但在換了git版本管理工具后廢棄捐下。

我們團隊所有項目都是使用的vue,新項目使用的vue-cli腳手架搭建萌业。 經(jīng)過過多次改進后坷襟,團隊現(xiàn)行的代碼規(guī)范執(zhí)行辦法:

1、統(tǒng)一使用編輯器 visual studio code生年。

2婴程、安裝擴展ESLint、Vetur晶框、Prettier - Code formatter排抬。

采用vue框架開發(fā) 所以需要安裝 Vetur? 高亮和格式化vue文件

3懂从、在項目的.eslintrc.js文件中配置統(tǒng)一的代碼檢測規(guī)范授段。? 很多大廠都公開有這個配置文件蹲蒲,可以參考。 我們也是拿了一份比較嚴格的過來侵贵,在使用的過程中不斷修改届搁,根據(jù)項目的實際情況放寬了部分規(guī)范。

4窍育、在編輯器首選項設(shè)置 autoFixOnSave 為true卡睦,可以在寫代碼過程中檢測不規(guī)范的地方,標紅并有問題說明漱抓”矶停看不明白的可以去eslint官網(wǎng)查相關(guān)說明。https://eslint.org/docs/rules/?乞娄。? 英文不好的瞬逊,可以去看騰訊云翻譯的機器版本 https://cloud.tencent.com/developer/chapter/12618

經(jīng)過以上設(shè)置,可以解決大部分因為換行仪或,空格之類的不規(guī)范問題确镊。

5、項目package.json 中寫入lint配置? ? "lint": "vue-cli-service lint --fix --ext .js,.vue src",? 這樣就可以使用npm run lint 來檢測代碼規(guī)范范删,同時自動修復(fù)部分不規(guī)范的地方蕾域。

6、交叉開發(fā)

經(jīng)過以上操作到旦,對有代碼潔癖范的我來說旨巷,團隊代碼看起來至少算是整齊了。但只是解決了代碼格式問題添忘,更多的問題還是需要人工review采呐。我們采用了交叉開發(fā)的方式,每個人不再是總維護一個或幾個項目昔汉,而是可能隨時被征調(diào)去開發(fā)任何項目懈万。這樣做的前提是我們前端的代碼邏輯不復(fù)雜,注釋清晰靶病,上手新項目的成本低会通。好處是順便revie前人的代碼,相互學(xué)習(xí)娄周,減輕代碼疲勞涕侈。人員離職交接很容易。

最后附上vscode編輯器的settings.json配置:

{

? ? "editor.wordWrap": "on",

? ? "files.associations": {

? ? ? ? "*.cjson": "jsonc",

? ? ? ? "*.wxss": "css",

? ? ? ? "*.wxs": "javascript"

? ? },

? ? "emmet.includeLanguages": {

? ? ? ? "wxml": "html"

? ? },

? ? "git.autofetch": true,

? ? "files.autoSave": "off",

? ? "eslint.validate": [

? ? ? ? "javascript",

? ? ? ? "javascriptreact",

? ? ? ? "vue-html",

? ? ? ? { "language": "vue", "autoFix": true }

? ? ],

? ? "eslint.autoFixOnSave": true,

? ? "prettier.tabWidth": 4,

? ? "minapp-vscode.disableAutoConfig": true,

? ? "vetur.format.options.tabSize": 4,

? ? "vetur.format.defaultFormatterOptions": {

? ? ? ? "js-beautify-html": {

? ? ? ? ? ? "wrap_attributes": "auto"

? ? ? ? }

? ? },

? ? "[jsonc]": {

? ? ? "editor.defaultFormatter": "esbenp.prettier-vscode"

? ? },

? ? "[javascript]": {

? ? ? "editor.defaultFormatter": "esbenp.prettier-vscode"

? ? },

? ? "vetur.format.defaultFormatter.html": "js-beautify-html"

}

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末煤辨,一起剝皮案震驚了整個濱河市裳涛,隨后出現(xiàn)的幾起案子木张,更是在濱河造成了極大的恐慌,老刑警劉巖端三,帶你破解...
    沈念sama閱讀 211,948評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件舷礼,死亡現(xiàn)場離奇詭異,居然都是意外死亡郊闯,警方通過查閱死者的電腦和手機妻献,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,371評論 3 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來团赁,“玉大人育拨,你說我怎么就攤上這事』渡悖” “怎么了熬丧?”我有些...
    開封第一講書人閱讀 157,490評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長怀挠。 經(jīng)常有香客問我析蝴,道長,這世上最難降的妖魔是什么唆香? 我笑而不...
    開封第一講書人閱讀 56,521評論 1 284
  • 正文 為了忘掉前任嫌变,我火速辦了婚禮,結(jié)果婚禮上躬它,老公的妹妹穿的比我還像新娘腾啥。我一直安慰自己,他們只是感情好冯吓,可當我...
    茶點故事閱讀 65,627評論 6 386
  • 文/花漫 我一把揭開白布倘待。 她就那樣靜靜地躺著,像睡著了一般组贺。 火紅的嫁衣襯著肌膚如雪凸舵。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,842評論 1 290
  • 那天失尖,我揣著相機與錄音啊奄,去河邊找鬼。 笑死掀潮,一個胖子當著我的面吹牛菇夸,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播仪吧,決...
    沈念sama閱讀 38,997評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼庄新,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起择诈,我...
    開封第一講書人閱讀 37,741評論 0 268
  • 序言:老撾萬榮一對情侶失蹤械蹋,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后羞芍,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體哗戈,經(jīng)...
    沈念sama閱讀 44,203評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,534評論 2 327
  • 正文 我和宋清朗相戀三年涩金,在試婚紗的時候發(fā)現(xiàn)自己被綠了谱醇。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片暇仲。...
    茶點故事閱讀 38,673評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡步做,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出奈附,到底是詐尸還是另有隱情全度,我是刑警寧澤,帶...
    沈念sama閱讀 34,339評論 4 330
  • 正文 年R本政府宣布斥滤,位于F島的核電站将鸵,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏佑颇。R本人自食惡果不足惜顶掉,卻給世界環(huán)境...
    茶點故事閱讀 39,955評論 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望挑胸。 院中可真熱鬧痒筒,春花似錦、人聲如沸茬贵。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,770評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽解藻。三九已至老充,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間螟左,已是汗流浹背啡浊。 一陣腳步聲響...
    開封第一講書人閱讀 32,000評論 1 266
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留胶背,地道東北人巷嚣。 一個月前我還...
    沈念sama閱讀 46,394評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像奄妨,于是被迫代替她去往敵國和親涂籽。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,562評論 2 349

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