使用方法
- 安裝依賴：在項目根目錄下執(zhí)行以下命令安裝 Commitlint 和 Husky
npm install --save-dev husky @commitlint/cli @commitlint/config-conventional
- 配置 Commitlint：在項目根目錄下創(chuàng)建 commitlint.config.js 文件，并寫入以下代碼
module.exports = {
extends: ['@commitlint/config-conventional']
};
- 配置 Husky：在項目的 package.json 文件中添加以下代碼
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
推薦的關鍵詞
Commitlint 默認使用的是 conventional commit 規(guī)范。Conventional commit 規(guī)范中推薦使用的關鍵詞包括：
-
fix：修復 bug。 -
feat：添加新功能。 -
docs：只修改了文檔。 -
style：修改了代碼的格式，不影響代碼的邏輯。 -
refactor：重構代碼，不修復 bug 也不添加新功能。 -
revert: 回滾。 -
perf：提高性能。 -
test：添加或修改測試用例。 -
build：影響了構建過程和依賴關系。 -
ci：修改了 CI 配置文件和腳本。 -
chore：修改了項目維護任務，例如更新版本號。
這些關鍵詞僅是 Conventional commit 規(guī)范中的建議，您也可以根據(jù)自己的需要自定義關鍵詞。希望對您有所幫助。
