簡介

在團隊協(xié)作開發(fā)過程中，規(guī)范化的 Git 提交信息可以提高代碼維護的效率，便于追蹤和定位問題。Commitizen 是一個幫助我們規(guī)范化 Git 提交信息的工具，它提供了一種交互式的方式來生成符合約定格式的提交信息。

原理

Commitizen 的核心原理是通過提供一個交互式的命令行工具，引導(dǎo)用戶按照預(yù)定義的格式填寫提交信息。它使用了 Node.js 的 Inquirer.js 庫來實現(xiàn)命令行交互，根據(jù)配置的提交信息模板，生成最終的提交信息。

安裝

首先，確保你已經(jīng)安裝了 Node.js 和 npm。然后，全局安裝 Commitizen：

npm install -g commitizen

接下來，在項目根目錄下初始化 Commitizen 配置：

commitizen init cz-conventional-changelog --save-dev --save-exact

這將在項目中安裝 cz-conventional-changelog 適配器，并在 package.json 中添加相應(yīng)的配置。

使用方式

安裝并配置完成后，你可以使用 git cz 命令來替代 git commit，這將啟動 Commitizen 的交互式提交信息填寫流程。

git cz 或者  npx git-cz

按照提示，逐步填寫提交信息的各個部分，如提交類型（feat、fix、docs 等）、提交范圍、簡短描述、詳細描述、破壞性變更、關(guān)閉的問題等。完成后，Commitizen 將生成符合約定格式的提交信息。

在項目中安裝并配置好 Commitizen 后，你可以使用 git cz 命令來替代 git commit，啟動交互式提交信息填寫流程。下面我們通過一個詳細的例子來說明每一步的過程。

假設(shè)我們在一個項目中完成了一個新功能的開發(fā)，現(xiàn)在要提交這些更改。

1. 在命令行中，進入項目根目錄，運行以下命令：

   npx git-cz

2. Commitizen 將啟動交互式提交信息填寫流程，首先會提示你選擇提交類型：

   選擇一個提交類型:feat: ? ? 新功能fix: ? ?  修復(fù) Bugdocs: ? ? 文檔更新style: ?  代碼樣式調(diào)整refactor: 代碼重構(gòu)perf: ? ? 性能優(yōu)化test: ? ? 添加或更新測試chore: ?  構(gòu)建過程或輔助工具的變動

   根據(jù)我們的更改類型，選擇 feat 并按下回車鍵。

   

3. 接下來，Commitizen 會提示你輸入提交的范圍（可選）：

   這次提交的改動所影響的范圍? (按回車鍵跳過)

   

   如果我們的更改影響到特定的模塊或組件，可以在這里輸入相應(yīng)的范圍，否則直接按回車鍵跳過。

4. 然后，Commitizen 會提示你輸入一個簡短的描述：

   寫一個簡短的變化描述，使用命令式語氣，盡量包含主語（50個字符以內(nèi)）:

   在這里，我們輸入一個簡潔明了的描述，說明這次提交的主要變化，例如：

   添加用戶注冊功能

   

5. 接下來，Commitizen 會提示你輸入一個更詳細的描述（可選）：

   提供一個更加詳細的變化描述（按回車鍵跳過）。使用 "|" 換行:

   如果需要提供更多關(guān)于這次變更的信息，可以在這里輸入多行描述，每行以 | 符號開頭。如果不需要詳細描述，直接按回車鍵跳過。

6. 然后，Commitizen 會詢問是否有任何破壞性變更：

   這次變化是否包含任何破壞性變更? (y/N)

   如果這次提交包含了破壞性變更，即可能影響到其他部分的功能或者與之前的版本不兼容，需要輸入 y 并按回車鍵。否則，直接按回車鍵選擇默認的 N。

7. 最后，Commitizen 會詢問這次提交是否關(guān)閉了某個 Issue：

   這次變化是否關(guān)閉了某個 Issue? (y/N)

   如果這次提交解決了某個 Issue，可以輸入 y 并在提示中輸入 Issue 的編號，多個 Issue 編號以逗號分隔。如果不關(guān)閉任何 Issue，直接按回車鍵選擇默認的 N。

? ? ? ? 8. 成以上步驟后，Commitizen 會生成符合約定格式的提交信息，并顯示出來供你確認：

    feat: 添加用戶注冊功能  確認無誤后，按回車鍵完成提交。

通過以上步驟，我們就使用 Commitizen 生成了一條規(guī)范化的提交信息，這樣就可以在項目中保持一致的提交信息格式，方便后續(xù)的維護和追蹤。

配置

Commitizen 的配置文件通常位于項目根目錄下的 .czrc 或 package.json 中的 config.commitizen 字段。

示例配置：

{"path": "cz-conventional-changelog","maxHeaderWidth": 100,"maxLineWidth": 100,"defaultType": "","defaultScope": "","defaultSubject": "","defaultBody": "","defaultIssues": "","types": {"feat": {"description": "新功能","title": "Features"},"fix": {"description": "Bug 修復(fù)","title": "Bug Fixes"},// ...}
}

你可以根據(jù)項目需求自定義提交類型、默認值等配置項。

插件開發(fā)

Commitizen 支持自定義適配器插件，以滿足不同項目的提交信息格式要求。你可以開發(fā)自己的適配器插件，或者使用社區(qū)提供的插件。

一個簡單的適配器插件示例：

const conventionalCommitTypes = require('conventional-commit-types');
?
module.exports = {prompter(cz, commit) {cz.prompt([{type: 'list',name: 'type',message: '選擇提交類型:',choices: conventionalCommitTypes.types,},{type: 'input',name: 'subject',message: '簡短描述:',validate: (input) => input.length > 0,},// ...]).then((answers) => {const message = `${answers.type}: ${answers.subject}`;commit(message);});},
};

插件需要導(dǎo)出一個 prompter 函數(shù)，接收 cz 和 commit 兩個參數(shù)。使用 cz.prompt 方法定義交互式問題，收集用戶輸入，最后調(diào)用 commit 函數(shù)生成最終的提交信息。

集成

Commitizen 可以與其他工具和流程集成，如 Git 鉤子、持續(xù)集成等。

例如，你可以在 Git 的 pre-commit 鉤子中檢查提交信息是否符合 Commitizen 的格式要求：

#!/bin/sh
?
# 檢查是否存在未暫存的更改
if ! git diff --quiet HEAD; thenecho "存在未暫存的更改，請先提交或暫存這些更改。"exit 1
fi
?
# 運行 Commitizen
exec < /dev/tty && node_modules/.bin/git-cz --hook || true

這樣，在每次提交前，都會自動啟動 Commitizen 的交互式提交信息填寫流程。

總結(jié)

Commitizen 是一個強大的工具，可以幫助我們規(guī)范化 Git 提交信息，提高代碼維護效率。通過簡單的安裝和配置，我們就可以在項目中使用 Commitizen，并且可以根據(jù)需求進行自定義和擴展。

希望這篇教程能夠幫助你快速上手 Commitizen，并在項目中應(yīng)用起來。如有任何問題，歡迎隨時交流探討。