Commitlint 使用入门

Commitlint 使用入门

💡 原文中文,约1400字,阅读约需4分钟。
📝

内容提要

Commitlint是一个用于检查Git提交的message是否符合项目规范的工具,可以方便快速浏览、查找、比较代码,生成Change log,触发CI流程。安装需要全局安装@commitlint/cli和@commitlint/config-conventional。配置规则使用@commitlint/config-conventional包含的约定式提交规则。使用commitlint命令测试commit message,打印规范检查信息和返回状态码。可以使用npx @commitlint/cli运行commitlint。配合Husky使用,在提交message前自动检查提交规范。

🎯

关键要点

  • Commitlint 是一个用于检查 Git 提交 message 是否符合项目规范的工具。
  • 规范的提交内容可以方便快速浏览、查找、比较代码,生成 Change log,触发 CI 流程。
  • 全局安装 @commitlint/cli 和 @commitlint/config-conventional。
  • 使用 commitlint 命令测试 commit message,打印规范检查信息和返回状态码。
  • 可以使用 npx @commitlint/cli 运行 commitlint。
  • 配合 Husky 使用,可以在提交 message 前自动检查提交规范。
➡️

继续阅读