让commit信息高大上，且不伤肝！

2023-12-12 16:40:00

揭秘规范的 Git 提交信息：一把维护代码库的利器

前言

提交信息是代码库中的基石，它记录了代码库的每一个改动，是了解代码库变化和协作的重要途径。一个清晰、规范的提交信息不仅能提高团队协作的效率，还能显著提升代码库的可维护性。

规范提交信息的必要性

想象一下，当你查看一个项目中的提交历史时，映入眼帘的是：

- 修改了点东西
- 这里加了一个函数
- 修复了 bug
- 优化了性能
- 更新了文档
- 重构了代码

这样的提交信息宛如雾里看花，让人一头雾水。你根本不知道改了什么，为什么改，改了之后有什么影响。

规范提交信息就是要解决这个问题。一个规范的提交信息应该具备以下特点：

简洁明了： 不超过一行，让人一目了然。
有意义： 说明改动的原因和目的，以及改动后的影响。
可读性强： 使用正确的语法和标点符号，让人容易理解。
一致性： 遵循团队统一的提交信息格式，保证代码库的整洁性。

规范提交信息的利器

为了规范提交信息，市面上有很多工具可以助你一臂之力：

Conventional Commits： 一种流行的规范格式，要求提交信息遵循 <type>(<scope>): <subject> 的格式。
Commitizen： 一款命令行工具，可以帮助你轻松生成规范的提交信息。
Git hooks： 一种在 git 操作中执行自定义脚本的机制，你可以用它来检查提交信息是否符合规范。

自定义脚本来检查提交信息

如果你不想使用工具，也可以自己写一个脚本来规范提交信息。以下是一个简单的 JavaScript 脚本来检查提交信息是否符合规范：

const chalk = require('chalk');
const fs = require('fs');

// 正则表达式，用于匹配规范的提交信息
const regex = /^([a-z0-9-]+)\((.*?)\): (.*)$/;

// 获取提交信息
const commitMessage = fs.readFileSync('.git/COMMIT_EDITMSG', 'utf8');

// 匹配提交信息
const match = regex.exec(commitMessage);

// 如果提交信息不符合规范，则报错
if (!match) {
  console.error(chalk.red('提交信息不符合规范！'));
  console.error('请遵循以下格式：<type>(<scope>): <subject>');
  process.exit(1);
}

// 获取提交信息中的类型、范围和主题
const type = match[1];
const scope = match[2];
const subject = match[3];

// 打印提交信息
console.log(chalk.green('提交信息符合规范！'));
console.log(`类型：${type}`);
console.log(`范围：${scope}`);
console.log(`主题：${subject}`);