探索 Commitlint：从零到一的 Git 提交校验工具
2023-10-20 20:28:49
引言
在软件开发中，维护一致且可读的提交记录至关重要。Commitlint 是一个强大的工具，它可以帮助开发者确保提交记录符合团队约定的规范。本文将深入探讨 Commitlint，从安装到配置和使用，为开发者提供一个全面指南，帮助他们从零开始使用 Commitlint。
安装
使用 NPM 包管理器安装 Commitlint：
npm install --save-dev @commitlint/cli
安装 husky
husky 是一个 Git 钩子管理器，用于在提交时自动执行任务。建议安装 husky 来简化 Commitlint 集成：
npm install --save-dev husky
新建配置文件
在项目根目录下创建一个名为 commitlint.config.js 的文件，用于配置 Commitlint。
配置文件
Commitlint 使用配置文件来定义提交校验规则。默认情况下，它会读取根目录下的 commitlint.config.js。也可以通过 --config 选项指定不同的配置文件。
配置项
Commitlint 提供了广泛的配置选项，包括：
- rules: 定义提交消息的验证规则
- extends: 扩展其他配置文件中的规则
- parserPreset: 指定消息解析器
- formatter: 指定格式化器
使用
配置好 Commitlint 后，可以通过在 Git 命令中添加 --commitlint-cli 选项来启用它：
git commit --message="feat: add new feature" --commitlint-cli
如果提交消息不符合规则，Commitlint 会输出错误信息并阻止提交。
示例
以下是使用 Commitlint 的示例配置文件：
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'type-enum': [2, 'always', ['feat', 'fix', 'refactor', 'docs', 'style']],
'scope-case': [2, 'always', 'lower-case'],
'subject-empty': [2, 'never'],
},
};
这个配置文件扩展了流行的 Conventional Commits 规范，并添加了额外的规则，例如强制使用小写的 scope 和禁止空 subject。
高级用法
Commitlint 提供了高级功能，例如：
- 忽略某些提交： 可以使用 --no-verify 选项或 ignorePatterns 配置忽略某些提交。
- 自定义规则： 可以通过创建自定义规则扩展 Commitlint 的功能。
- 使用工具集成： Commitlint 可以与编辑器和 IDE 集成，例如 VSCode 和 JetBrains IDE。
结论
Commitlint 是一个必不可少的工具，它可以帮助软件开发团队保持一致且可读的提交记录。通过遵循本文中的步骤，开发者可以轻松地从零开始使用 Commitlint，并提升他们的 Git 工作流程。
