git 提交规范插件

安装插件

pnpm install @commitlint/cli @commitlint/config-conventional --save-dev

在根目录新增配置文件.commitlintrc.js

module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
    "type-enum": [
      2,
      "always",
      [
        "feat", // 新功能
        "fix", // Bug 修复
        "docs", // 文档更新
        "style", // 代码样式调整（不影响逻辑）
        "refactor", // 代码重构（非功能/非Bug）
        "test", // 测试相关
        "chore", // 构建/工具链变更
        "revert", // 回滚提交
        "perf", // 性能优化
      ],
    ],
    "subject-case": [0], // 允许提交信息使用任意大小写（如 'Fix bug' 或 'fix bug'）
  },
};

husky和commitlint配合完成提交时自动验证 commit 规范

在.husky文件夹中新增commit-msg文件

#!/bin/sh
npx --no-install commitlint --edit "$1"

提交示例

类型	说明	示例
feat	新功能	feat(user): 新增用户管理功能
fix	Bug 修复	fix(user): 修复用户管理功能
docs	文档更新	docs(user): 更新用户管理文档
style	代码样式调整（不影响逻辑）	style(user): 调整用户管理代码样式
refactor	代码重构（非功能/非 Bug）	refactor(user): 重构用户管理代码
test	测试相关	test(user): 测试用户管理功能
chore	构建/工具链变更	chore(eslint): 修改 eslint 规则
revert	回滚提交	revert(user): 回滚用户管理功能
perf	性能优化	perf(user): 优化用户管理性能