Git Commit 消息格式化工具：git-commit-msg-linter

原创于 2025-05-28 09:00:05 发布 · 254 阅读

CC 4.0 BY-SA版权

Git Commit 消息格式化工具：git-commit-msg-linter

git-commit-msg-linter git commit message linter hook 项目地址: https://gitcode.com/gh_mirrors/gi/git-commit-msg-linter

1. 项目介绍

git-commit-msg-linter 是一个轻量级、独立的 Git 提交消息格式化工具。它基于 Angular 的提交消息指南，通过钩子（hook）在每次提交时检查提交消息是否符合规定的格式。如果不符合，提交将被终止。此工具无需任何配置即可使用，非常适合希望在项目中统一提交消息格式的团队。

2. 项目快速启动

首先，您需要将 git-commit-msg-linter 安装为开发依赖：

npm install git-commit-msg-linter --save-dev

安装后，commit-msg 钩子将被复制到项目根目录下的 .git/hooks/ 目录中。如果已经存在 commit-msg 钩子，它会被重命名为 commit-msg.old。

现在，每次尝试提交时，工具都会自动检查您的提交消息是否符合预设格式。

3. 应用案例和最佳实践

提交消息格式

推荐的提交消息格式如下：

<类型>(<范围>): <简短摘要>

<类型>：如 feat（新功能）、fix（修复）、docs（文档）等。
<范围>：可选，用于指定更改的范围，如模块名、组件名等。
<简短摘要>：当前更改的简短描述，用现在时态，首字母不需要大写，句尾不需要句号。

配置文件

如果需要自定义类型和规则，可以在项目根目录下创建或修改 commitlinterrc.json 文件。以下是一个配置文件示例：

{
  "types": {
    "feat": "用户可感知的新功能",
    "build": "影响构建系统或外部依赖的更改（例如：gulp、broccoli、npm）",
    "deps": "添加、升级或删除依赖",
    "temp": false
  },
  "max-len": 80,
  "debug": true
}