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

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

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

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

commitlint: git 提交信息規(guī)范與驗證
husky: 使ghook更容易
standard-version: 自動生成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)

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

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

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/96275.html

相關(guān)文章

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

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

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

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

chemzqm 2019-08-23 10:26 評論0 收藏0
Lint Your Code

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

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

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

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

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

Miracle_lihb 2019-08-16 14:28 評論0 收藏0