资源描述
commitlint 是一款强大的 Git 提交信息规范检查工具。它通过自动化校验提交日志格式，帮助开发团队统一代码提交规范，提升项目日志的可读性与可维护性。适用于各类需要严格代码版本管理的团队协作场景，支持自定义规则与主流规范（如 Angular 规范），是构建高质量 CI/CD 流水线和自动化发版的必备基础设施。
详细内容
## 工具定位与核心价值
commitlint 是一款专门用于检查 Git 提交消息（Commit Message）是否符合特定规范的命令行工具。其核心价值在于通过强制性的自动化校验，消除人为疏忽，确保团队提交历史清晰、规范。这不仅提升了代码版本回溯的效率，更为后续的自动化版本发布（如 semantic-release）和变更日志（CHANGELOG）生成奠定了标准化的数据基础。
## 主要功能列表
- **丰富的预设规范**：内置支持多种主流提交规范，如 `@commitlint/config-conventional`（基于 Angular 规范），开箱即用。
- **高度可定制**：允许团队根据项目需求灵活自定义校验规则，包括 Header 长度限制、Type 枚举类型、Scope 范围校验等。
- **无缝集成 Git Hooks**：通常配合 `husky` 使用，在代码执行 `git commit` 时自动触发检查，实时拦截不合规的提交。
- **多环境支持**：支持通过命令行（CLI）直接调用或作为 Node.js API 集成，轻松接入各类 CI/CD 流水线。
## 典型使用场景
- **多人团队协作**：统一多人协作项目的提交信息格式，杜绝“update”、“fix”等模糊提交，提升代码审查（Code Review）和版本管理效率。
- **自动化版本发布**：配合 semantic-release 等工具，通过严格规范的 commit message 自动分析语义化版本号（SemVer）并自动生成发布日志。
- **CI/CD 质量卡点**：在持续集成环境（如 GitHub Actions, GitLab CI）中增加 commitlint 检查步骤，拦截不合规的合并请求，保障主干代码库的规范性。
## 上手步骤或操作要点
1. **安装依赖**：在项目根目录安装 commitlint CLI 及预设配置包。
```bash
npm install --save-dev @commitlint/cli @commitlint/config-conventional
```
2. **创建配置文件**：在项目根目录创建 `commitlint.config.js`，并引入预设配置。
```javascript
module.exports = {
extends: ['@commitlint/config-conventional']
};
```
3. **集成 Git Hooks**：安装 `husky` 以管理 Git 钩子，并配置 `commit-msg` 钩子触发 commitlint。
```bash
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'
```
4. **测试验证**：尝试提交不符合规范的 message（如 `git commit -m "foo: bar"`）验证拦截效果，再使用标准格式（如 `git commit -m "feat: add new feature"`）验证放行。