0%

Commitlint 提交规范

Commitlint 是什么?

Commitlint 检查 Git 提交信息格式。

安装

1
npm install @commitlint/cli @commitlint/config-conventional --save-dev

配置

1
2
3
4
// commitlint.config.js
module.exports = {
extends: ['@commitlint/config-conventional']
};

提交类型

  • feat: 新功能
  • fix: 修复
  • docs: 文档
  • style: 样式
  • refactor: 重构
  • test: 测试
  • chore: 杂项

使用

1
echo "feat: add new feature" | npx commitlint

与 Husky 结合

1
npx husky add .husky/commit-msg "npx --no-install commitlint --edit \$1"

总结

Commitlint 保持提交历史清晰。团队协作必备。