自動(dòng)格式化以及提交代碼時(shí)的優(yōu)化配置

概覽:

prettier

eslint fix

git hook

commitlint


以配置js為例

第一步 格式化所有代碼 prettier

yarn add prettier -D

在package.json的script里面添加如下配置菠净,注意修改成自己的文件路徑虾宇,采用glob配置册舞。

"format":"prettier --single-quote --trailing-comma es5 --write \"src/**/*.js\"",

配置完畢容燕,可以執(zhí)行?yarn format測(cè)試一下左电。

更多配置訪問官網(wǎng)?https://prettier.io/docs/en/install.html

如果有eslint配置文件,會(huì)發(fā)現(xiàn)格式化之后酿矢,有些不符合eslint規(guī)范絮缅,配置eslint。

第二步 配置Eslint

yarn add -D eslint

假設(shè)你已經(jīng)配置好eslint的配置文件 在package.json的scripts里添加如下荠锭,注意修改成自己的文件路徑旱眯。

"fix":"eslint --fix \"src/**/*.js\""

配置完畢。 執(zhí)行完?yarn format之后再執(zhí)行?yarn fix证九,完美自動(dòng)格式化所有JS代碼删豺。

此時(shí)我們配置format的語句如下:

"format":"prettier --single-quote --trailing-comma es5 --write \"src/**/*.js\" && yarn fix",

可以一次實(shí)現(xiàn)格式化和fix。

更多信息?https://eslint.org/

第三步 添加Git鉤子(Pre-commit Hook)

Git 鉤子(hooks)是在Git 倉庫中特定事件(certain points)觸發(fā)后被調(diào)用的腳本愧怜。 詳情可瀏覽?https://git-scm.com/book/zh/v2/%E8%87%AA%E5%AE%9A%E4%B9%89-Git-Git-%E9%92%A9%E5%AD%90

每次提交代碼呀页,執(zhí)行?git commit之后進(jìn)行自動(dòng)格式化,免去每次人為手動(dòng)格式化叫搁,使遠(yuǎn)程倉庫代碼保持風(fēng)格統(tǒng)一赔桌。

yarn add lint-staged husky --dev

在package.json里面配置

{"scripts":{"precommit":"lint-staged"},"lint-staged":{"*.js":["yarn run format -- ","git add"]}}

配置完成。 這樣每次git commit 都會(huì)自動(dòng)執(zhí)行格式化并fix渴逻,成功之后會(huì)將格式化之后的文件自動(dòng)add疾党,然后統(tǒng)一commit。

第四步 添加git commit注釋規(guī)范

yarn add -D @commitlint/cli @commitlint/config-conventional

在根目錄下面添加commitlint.config.js文件惨奕,內(nèi)容如下:

module.exports={extends:['@commitlint/config-conventional'],rules:{'type-enum':[2,'always',['merge','add','update','delete','feat','fix','docs','style','refactor','test','revert']],'subject-case':[0,'never',['lower-case']]}}

提交commit格式如下:

type: subjectName

bodyDetail

For example:

add: 添加了readme.md文件

添加了X的配置

添加了文檔

配置package.json

{"scripts":{"commitmsg":"commitlint -e $GIT_PARAMS"}}

配置完畢雪位。

更多信息請(qǐng)查看:http://marionebl.github.io/commitlint/#/

現(xiàn)在提交代碼,只需要執(zhí)行g(shù)it commit然后格式化成功之后梨撞,進(jìn)入默認(rèn)編輯器(我的是VIM)雹洗,填寫commit香罐。wq保存就OK了。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末时肿,一起剝皮案震驚了整個(gè)濱河市庇茫,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌螃成,老刑警劉巖旦签,帶你破解...
    沈念sama閱讀 210,914評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異寸宏,居然都是意外死亡宁炫,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,935評(píng)論 2 383
  • 文/潘曉璐 我一進(jìn)店門氮凝,熙熙樓的掌柜王于貴愁眉苦臉地迎上來羔巢,“玉大人,你說我怎么就攤上這事罩阵「透眩” “怎么了?”我有些...
    開封第一講書人閱讀 156,531評(píng)論 0 345
  • 文/不壞的土叔 我叫張陵永脓,是天一觀的道長袍辞。 經(jīng)常有香客問我鞋仍,道長常摧,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,309評(píng)論 1 282
  • 正文 為了忘掉前任威创,我火速辦了婚禮落午,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘肚豺。我一直安慰自己溃斋,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,381評(píng)論 5 384
  • 文/花漫 我一把揭開白布吸申。 她就那樣靜靜地躺著梗劫,像睡著了一般。 火紅的嫁衣襯著肌膚如雪截碴。 梳的紋絲不亂的頭發(fā)上梳侨,一...
    開封第一講書人閱讀 49,730評(píng)論 1 289
  • 那天,我揣著相機(jī)與錄音日丹,去河邊找鬼走哺。 笑死,一個(gè)胖子當(dāng)著我的面吹牛哲虾,可吹牛的內(nèi)容都是我干的丙躏。 我是一名探鬼主播择示,決...
    沈念sama閱讀 38,882評(píng)論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼晒旅!你這毒婦竟也來了栅盲?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,643評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤废恋,失蹤者是張志新(化名)和其女友劉穎剪菱,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體拴签,經(jīng)...
    沈念sama閱讀 44,095評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡孝常,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,448評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蚓哩。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片构灸。...
    茶點(diǎn)故事閱讀 38,566評(píng)論 1 339
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖岸梨,靈堂內(nèi)的尸體忽然破棺而出喜颁,到底是詐尸還是另有隱情,我是刑警寧澤曹阔,帶...
    沈念sama閱讀 34,253評(píng)論 4 328
  • 正文 年R本政府宣布半开,位于F島的核電站,受9級(jí)特大地震影響赃份,放射性物質(zhì)發(fā)生泄漏寂拆。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,829評(píng)論 3 312
  • 文/蒙蒙 一抓韩、第九天 我趴在偏房一處隱蔽的房頂上張望纠永。 院中可真熱鬧,春花似錦谒拴、人聲如沸尝江。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,715評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽炭序。三九已至,卻和暖如春苍日,著一層夾襖步出監(jiān)牢的瞬間惭聂,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,945評(píng)論 1 264
  • 我被黑心中介騙來泰國打工易遣, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留彼妻,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,248評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像侨歉,于是被迫代替她去往敵國和親屋摇。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,440評(píng)論 2 348

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