git-cz:用于生成符合 Conventional Commits 標(biāo)準(zhǔn)的提交消息的工具,以便更規(guī)范地記錄項目的提交歷史。
配置:
-
安裝
commitizen和cz-customizable:npm install --save-dev commitizen cz-customizable -
在
package.json中配置config.commitizen:在
package.json文件中添加如下配置:"config": { "commitizen": { "path": "./node_modules/cz-customizable" } } -
添加
.cz-config.js文件:在項目根目錄下創(chuàng)建一個
.cz-config.js文件,用于配置提交信息的規(guī)范。以下是一個示例配置:javascriptCopy code module.exports = { types: [ { value: 'feat', name: 'feat: 新增功能' }, { value: 'fix', name: 'fix: 修復(fù) bug' }, { value: 'docs', name: 'docs: 文檔變更' }, { value: 'style', name: 'style: 代碼格式變更(不影響功能,比如空格、格式化、缺失的分號等)' }, { value: 'refactor', name: 'refactor: 代碼重構(gòu)' }, { value: 'perf', name: 'perf: 性能優(yōu)化' }, { value: 'test', name: 'test: 添加或修改測試' }, { value: 'chore', name: 'chore: 構(gòu)建過程或輔助工具的變更' }, { value: 'revert', name: 'revert: 回滾到上一個版本' } ], allowCustomScopes: true, allowBreakingChanges: ['feat', 'fix'] };這里定義了一些常見的提交類型和相關(guān)的說明。
-
使用
git-cz進行提交: 引導(dǎo)生成符合規(guī)范的提交信息。替代使用
git commit,運行以下命令來使用git-cz:npx git-cz -
提交到版本庫:
生成的提交信息將自動添加到版本庫,之后可以繼續(xù)推送到遠程倉庫。