commitlint

commitlint 是一个开源命令行工具,用于检查 Git 提交信息(commit message)是否符合预先约定的书写规范。它最常搭配 Conventional Commits(约定式提交)规范使用,把不规范的提交信息在源头拦截下来。

概述

在多人协作的项目中,提交信息往往风格各异,既难以阅读,也无法被程序解析。约定式提交是一种流行的提交信息规范,要求信息以类型前缀开头,例如新功能、缺陷修复、文档等,后跟可选的作用域和简短描述。commitlint 读取这些规则,对每条提交信息进行语法校验,不符合规范时报错并阻止提交。它通常与提交钩子工具配合,在提交动作触发时自动运行。

核心特点

• 规则可配置:通过配置文件设定类型枚举、标题最大长度、作用域大小写等约束,并可继承社区共享的规则集。
• 与规范生态整合:天然支持约定式提交,配合相关工具可从提交历史自动推导语义化版本号并生成变更日志。
• 插件式扩展:支持自定义规则和解析器,适配企业内部的提交约定。
• 可嵌入流水线:除本地钩子外,也能在持续集成中批量校验合并请求中的所有提交。

应用场景

commitlint 主要用于希望维护整洁、可自动化处理的提交历史的团队。规范化的提交信息使得变更日志可以自动生成,版本号可以按变更类型自动递增,代码回溯和问题定位也更加高效。它在开源库、组件库以及需要频繁发布的前端与后端项目中尤为常见。

常见问题

问:commitlint 会修改我的提交信息吗?答:不会。它只做校验并给出错误提示,是否修改由开发者决定;若需交互式生成规范信息,可搭配专门的提交助手工具。

问:必须使用约定式提交规范吗?答:不是。约定式提交只是最常用的预设,团队完全可以自定义规则集来匹配自己的提交约定。

问:如何避免不规范提交进入主分支?答:除本地提交钩子外,建议在持续集成中对合并请求的每条提交运行 commitlint,作为兜底校验。