首页/开发/代码质量与评审速查/commitlint:提交信息规范检查
规范与静态检查65 条

commitlint:提交信息规范检查

commitlint 校验提交信息是否符合约定格式(如 Conventional Commits):type、scope、subject 结构固定,配合 husky 在 commit-msg 钩子拦截,CI 兜底校验。

校验type(scope): subject 结构
钩子commit-msg(本地)
配置commitlint.config.js + extends

配置示例

配置示例
npm i -D @commitlint/cli @commitlint/config-conventional
# commit-msg 钩子
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
约定提交信息是自动化前提:生成 changelog、版本号递增、触发发布都依赖稳定的 type 词表。

易错点

  • 规则与团队术语不匹配(生造 type):成员反复被拦,开始绕过钩子
  • 只在本地钩子校验:CI 未做兜底,--no-verify 可绕

数据来源与参考

  • Conventional Commits 规范(conventionalcommits.org)与 commitlint 文档
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌