使用commitlint規(guī)范git提交

Miracle 發(fā)布于2019-08-22 18:50 / 1708人閱讀

摘要：在我們開(kāi)始一個(gè)項(xiàng)目的時(shí)候通常會(huì)用去規(guī)范代碼。我們還可以用一些命令行工具去規(guī)范我們的提交信息以及在每次操作過(guò)程中執(zhí)行一些測(cè)試，最快可以依據(jù)提交信息生成文件提交信息規(guī)范與驗(yàn)證使更容易自動(dòng)生成并發(fā)布版本安裝配置和使用具體參考相應(yīng)官網(wǎng)

在我們開(kāi)始一個(gè)項(xiàng)目的時(shí)候通常會(huì)用eslint去規(guī)范js代碼。我們還可以用一些命令行工具去規(guī)范我們的git提交信息以及在每次git操作過(guò)程中執(zhí)行一些測(cè)試，最快可以依據(jù)git提交信息生成CHANGELOG文件

commitlint: git 提交信息規(guī)范與驗(yàn)證
husky: 使ghook更容易
standard-version: 自動(dòng)生成CHANGELOG 并發(fā)布版本

安裝

npm install --save-dev @commitlint/{config-conventional,cli}
npm i --save-dev standard-version
npm install husky --save-dev

配置

commitlint
echo "module.exports = {extends: ["@commitlint/config-conventional"]}" > commitlint.config.js
// commitlint.config.js
 module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
  "type-enum": [2, "always", [
     "feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"
   ]],
  "scope-empty": [2, "never"],
  "subject-full-stop": [0, "never"], 
  "subject-case": [0, "never"]
  }};

Standard-version 和 husky

// package.json
 "scripts": {
  "lint": "eslint .",
  "commitmsg": "commitlint -e $GIT_PARAMS",
  "release": "standard-version",
  "validate": "npm prune",
  "pre-commit": "npm run lint",
  "pre-push": "npm run validate",
  "npmi": "npm i",
  "post-merge": "npm run npmi",
  "post-rewrite": "npm run npmi"
 }

使用

具體參考相應(yīng)官網(wǎng)

云服務(wù)器 GPU云服務(wù)器維持整潔的 Git 提交記錄使用規(guī)范 git使用流程 commitlint

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/96275.html

相關(guān)文章

前端代碼風(fēng)格自動(dòng)化系列（二）之Commitlint

摘要：文件配置配置說(shuō)明由和配置數(shù)組組成，如，數(shù)組中第一位為，可選，為，為，為，第二位為應(yīng)用與否，可選，第三位該的值。在有了Husky賦能之后，我們有能力在Git的鉤子里做一些事情，首先不得不提的是代碼的提交規(guī)范和規(guī)范的校驗(yàn)，優(yōu)雅的提交，方便團(tuán)隊(duì)協(xié)作和快速定位問(wèn)題。首推Commitlint，另外@加神推薦了Gitmoji也是一個(gè)很有意思的工具。安裝 npm install --save-...

FuisonDesign 2019-08-23 14:33 評(píng)論0 收藏0
vue，react 配置 commitlint 和 eslint 鉤子

摘要：官網(wǎng)倉(cāng)庫(kù)倉(cāng)庫(kù)中文官網(wǎng)一配置搭配的鉤子后，每次提交版本信息的時(shí)候，會(huì)根據(jù)配置的規(guī)則進(jìn)行校驗(yàn)，若不符合規(guī)則會(huì)失敗，并提示相應(yīng)信息。添加字段的配置跳過(guò)校驗(yàn)使用指令可以跳過(guò)檢驗(yàn)規(guī)則代碼規(guī)范強(qiáng)制提交測(cè)試關(guān)于 commitlint, husky, eslint 的具體信息可以見(jiàn)官網(wǎng)。 commitlint: 官網(wǎng), github 倉(cāng)庫(kù) husky： github 倉(cāng)庫(kù) eslint 中文官...

chemzqm 2019-08-23 10:26 評(píng)論0 收藏0
Lint Your Code

摘要：形成良好統(tǒng)一的代碼規(guī)范，有利于提高代碼的可讀性，減少潛在的錯(cuò)誤，便于團(tuán)隊(duì)協(xié)作開(kāi)發(fā)。其中是可選的，如果沒(méi)有則禁用所有規(guī)則，如果有則禁用所有規(guī)則。也可以定義一個(gè)命令同時(shí)運(yùn)行這兩個(gè)命令，我在這里使用了我們定義了在鉤子觸發(fā)時(shí)會(huì)執(zhí)行命令。形成良好統(tǒng)一的代碼規(guī)范，有利于提高代碼的可讀性，減少潛在的錯(cuò)誤，便于團(tuán)隊(duì)協(xié)作開(kāi)發(fā)。本文簡(jiǎn)單介紹JS、CSS、 Git Commit 的規(guī)范工具及用法。 Lin...

hidogs 2019-08-23 10:27 評(píng)論0 收藏0
從0到1開(kāi)發(fā)實(shí)戰(zhàn)手機(jī)站（二）：Git提交規(guī)范配置

摘要：既然是實(shí)戰(zhàn)項(xiàng)目，我們也得在寫(xiě)頁(yè)面之前把相關(guān)的規(guī)范配置做好。使用來(lái)執(zhí)行規(guī)范全局安裝下需在前面加項(xiàng)目目錄下執(zhí)行配好后，之后用到命令時(shí)，改為使用。使用效驗(yàn)提交信息首先還是安裝依賴(lài)也會(huì)安裝但自且并不和之后的版本兼容。生活不能隨意過(guò)，代碼也不能隨意寫(xiě)。前一篇文章我們已經(jīng)把項(xiàng)目搭建好了，那是不是馬上就開(kāi)始寫(xiě)頁(yè)面了呀？ NO！無(wú)論在哪家公司，都會(huì)有相應(yīng)的代碼規(guī)范。新入職的員工往往第一步就要接受...

nanchen2251 2019-08-23 14:44 評(píng)論0 收藏0
從0到1開(kāi)發(fā)實(shí)戰(zhàn)手機(jī)站（二）：Git提交規(guī)范配置

摘要：既然是實(shí)戰(zhàn)項(xiàng)目，我們也得在寫(xiě)頁(yè)面之前把相關(guān)的規(guī)范配置做好。使用來(lái)執(zhí)行規(guī)范全局安裝下需在前面加項(xiàng)目目錄下執(zhí)行配好后，之后用到命令時(shí)，改為使用。使用效驗(yàn)提交信息首先還是安裝依賴(lài)也會(huì)安裝但自且并不和之后的版本兼容。生活不能隨意過(guò)，代碼也不能隨意寫(xiě)。前一篇文章我們已經(jīng)把項(xiàng)目搭建好了，那是不是馬上就開(kāi)始寫(xiě)頁(yè)面了呀？ NO！無(wú)論在哪家公司，都會(huì)有相應(yīng)的代碼規(guī)范。新入職的員工往往第一步就要接受...

Miracle_lihb 2019-08-16 14:28 評(píng)論0 收藏0