一、准备环境

node：v22.11.0
yarn：1.22.22
npm ：10.9.0
react：18.3.1
react-dom： 18.3.1
typescript： 4.9.5

二、安装依赖

yarn add husky lint-staged @commitlint/cli @commitlint/config-conventional -D
// 安装后的依赖版本：
// husky：9.1.7
// lint-staged：15.4.3
// @commitlint/cli：19.7.1
// @commitlint/config-conventional：19.7.1

1. Husky

Husky是 Git 钩子工具，可以设置在 git 各个阶段（pre-commit、commit-msg 等）触发。

2. lint-staged

lint-staged是一个在 git add 到暂存区的文件运行 linters (ESLint/Prettier/StyleLint) 的工具，避免在 git commit 提交时在整个项目执行。lint-staged 可以让你当前的代码检查 只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送。

3. Commitlint

Commitlint检查你的提交消息是否符合常规的提交格式

• @commitlint/cli 是一个命令行工具，用于校验 Git 提交信息是否符合规范
• @commitlint/config-conventional 是一种标准化的提交规范，基于Angular的提交规范

三、配置lint-staged规范

// package.json
{
  ...
  "scripts": {
    ...
   "prepare": "husky",
    "lint-staged": "git add .&&npx lint-staged"
  },
"lint-staged": {
    "*": [
      "yarn lint:fix",
      "yarn format"
    ],
  },
}

四、husky配置

1. 生成husky配置文件

npx husky init
// 执行命令后，自动生成的 .husky 目录和指令：

2. pre-commit钩子配置

修改提交前钩子命令.husky/pre-commit
该文件之前执行npx husky init时候就会自动生成

yarn lint-staged

3. commit-msg钩子配置

添加提交信息校验的钩子文件： .husky/commit-msg，内容为：

npx --no -- commitlint --edit "$1"

五、Commitlint 配置

根目录下创建 commitlint.config.js 配置文件
注意：确保保存为 UTF-8 的编码格式，否则可能会出现错误。
配置内容为：

module.exports = {
  // 继承的规则
  extends: ['@commitlint/config-conventional'],
  // @see: https://commitlint.js.org/#/reference-rules
  rules: {
    'subject-case': [0], // subject大小写不做校验

    // 类型枚举，git提交type必须是以下类型
    'type-enum': [
      // 当前验证的错误级别
      2,
      // 在什么情况下进行验证，always表示一直进行验证
      'always',
      [
        'feat', // 新增功能
        'fix', // 修复缺陷
        'docs', // 文档变更
        'style', // 代码格式（不影响功能，例如空格、分号等格式修正）
        'refactor', // 代码重构（不包括 bug 修复、功能新增）
        'perf', // 性能优化
        'test', // 添加疏漏测试或已有测试改动
        'build', // 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）
        'ci', // 修改 CI 配置、脚本
        'revert', // 回滚 commit
        'chore', // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
      ],
    ],
  },
};

六、测试提交

git commit -m "不规范的提交" // 没有git类型
git commit -m "build:不规范的提交" // 冒号后面需要有空格
git commit -m "build: 规范的提交" // git类型+英文格式冒号+空格+提交描述

七、cz-git命令工具添加（可选）

cz-git一款git commit 统一规范的工具(用git cz替代git commit '' )

1、全局安装Commitizen

npm install -g commitizen

2、cz-git 依赖安装

yarn add -D cz-git
// 安装后的依赖版本：
// cz-git：1.11.0

3、配置

1.修改 package.json 添加 config 指定使用的适配器

{
  ...
  "scripts": {
  ...
  },
  "config": {
    "commitizen": {
      "path": "node_modules/cz-git"
    }
  }
}

2.修改 commitlint.config.js 添加 prompt 配置

// commitlint.config.js
module.exports = {
  rule: {
    ...
  },
  prompt: {
  messages: {
      type: '选择你要提交的类型 :',
      scope: '选择一个提交范围（可选）:',
      customScope: '请输入自定义的提交范围 :',
      subject: '填写简短精炼的变更描述 :\n',
      body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
      breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
      footerPrefixesSelect: '选择关联issue前缀（可选）:',
      customFooterPrefix: '输入自定义issue前缀 :',
      footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
      generatingByAI: '正在通过 AI 生成你的提交简短描述...',
      generatedSelectByAI: '选择一个 AI 生成的简短描述:',
      confirmCommit: '是否提交或修改commit ?',
    },
    // prettier-ignore
    types: [
      { value: "feat",     name: "特性:     ✨  新增功能", emoji: ":sparkles:" },
      { value: "fix",      name: "修复:     🐛  修复缺陷", emoji: ":bug:" },
      { value: "docs",     name: "文档:     📝  文档变更", emoji: ":memo:" },
      { value: "style",    name: "格式:     💄  代码格式（不影响功能，例如空格、分号等格式修正）", emoji: ":lipstick:" },
      { value: "refactor", name: "重构:     ♻️  代码重构（不包括 bug 修复、功能新增）", emoji: ":recycle:" },
      { value: "perf",     name: "性能:     ⚡️  性能优化", emoji: ":zap:" },
      { value: "test",     name: "测试:     ✅  添加疏漏测试或已有测试改动", emoji: ":white_check_mark:"},
      { value: "build",    name: "构建:     📦️  构建流程、外部依赖变更（如升级 npm 包、修改 vite 配置等）", emoji: ":package:"},
      { value: "ci",       name: "集成:     🎡  修改 CI 配置、脚本",  emoji: ":ferris_wheel:"},
      { value: "revert",   name: "回退:     ⏪️  回滚 commit",emoji: ":rewind:"},
      { value: "chore",    name: "其他:     🔨  对构建过程或辅助工具和库的更改（不影响源文件、测试用例）", emoji: ":hammer:"},
    ],
    useEmoji: true,
    emojiAlign: 'center',
    useAI: false,
    aiNumber: 1,
    themeColorCode: '',
    scopes: [],
    allowCustomScopes: true,
    allowEmptyScopes: true,
    customScopesAlign: 'bottom',
    customScopesAlias: 'custom',
    emptyScopesAlias: 'empty',
    upperCaseSubject: false,
    markBreakingChangeMode: false,
    allowBreakingChanges: ['feat', 'fix'],
    breaklineNumber: 100,
    breaklineChar: '|',
    skipQuestions: [],
    issuePrefixes: [{ value: 'closed', name: 'closed:   ISSUES has been processed' }],
    customIssuePrefixAlign: 'top',
    emptyIssuePrefixAlias: 'skip',
    customIssuePrefixAlias: 'custom',
    allowCustomIssuePrefix: true,
    allowEmptyIssuePrefix: true,
    confirmColorize: true,
    maxHeaderLength: Infinity,
    maxSubjectLength: Infinity,
    minSubjectLength: 0,
    scopeOverrides: undefined,
    defaultBody: '',
    defaultIssues: '',
    defaultScope: '',
    defaultSubject: '',
  }
}

3.cz-git 验证

执行前需将改动的文件通过 git add 添加到暂存区

git cz

执行命令之后会出现询问交互，根据提示一步步的完善 commit msg 信息

八、参考

husky参考1：https://blog.csdn.net/weixin_51799004/article/details/138308098