【vue3-element-admin】Husky + Lint-staged + Commitlint + Commitizen + cz-git 配置 Git 提交規範

前言

本文介紹 vue3-element-admin 如何通過 Husky + Lint-staged + Commitlint + Commitizen + cz-git 來配置 Git 提交代碼規範。

核心內容是配置 Husky 的 pre-commit 和 commit-msg 兩個鉤子:

pre-commit：Husky + Lint-staged 整合實現 Git 提交前代碼規範檢測/格式化 (前提：ESlint + Prettier + Stylelint 代碼統一規範)；

commit-msg: Husky + Commitlint + Commitizen + cz-git 整合實現生成規範化且高度自定義的 Git commit message。

Husky

Husky 是 Git 鉤子工具，可以設置在 git 各個階段（pre-commit、commit-msg 等）觸發。

官方網站：https://typicode.github.io/husky

Husky 安裝有 自動安裝 和 手動安裝 兩種方式 。

官方推薦自動安裝的方式，使用 husky-init 命令一次性完成依賴自動安裝和配置

npx husky-init && npm install

自動生成的 .husky 目錄和指令：

Lint-staged

lint-staged 是一個在 git add 到暫存區的文件運行 linters (ESLint/Prettier/StyleLint) 的工具，避免在 git commit 提交時在整個項目執行。

官方網站：https://github.com/okonet/lint-staged

Lint-staged 安裝

npm install -D lint-staged

Lint-staged 配置

檢測/格式化配置

package.json 中添加不同文件在 git 提交執行的 lint 檢測配置

"lint-staged": {
    "*.{js,ts}": [
      "eslint --fix",
      "prettier --write"
    ],
    "*.{cjs,json}": [
      "prettier --write"
    ],
    "*.{vue,html}": [
      "eslint --fix",
      "prettier --write",
      "stylelint --fix"
    ],
    "*.{scss,css}": [
      "stylelint --fix",
      "prettier --write"
    ],
    "*.md": [
      "prettier --write"
    ]
  }

添加 lint-staged 指令

package.json 的 scripts 添加 lint-staged 指令

  "scripts": {
    "lint:lint-staged": "lint-staged"
  }

修改提交前鉤子命令

根目錄 .husky 目錄下 pre-commit 文件中的 npm test 修改爲 npm run lint:lint-staged

#npm test
npm run lint:lint-staged

Git 提交代碼檢測

Commitlint

Commitlint 檢查您的提交消息是否符合 Conventional commit format。-- Commitlint 官網

Commitlint 安裝

參考 官方安裝文檔

npm install -D @commitlint/cli @commitlint/config-conventional

Commitlint 配置

根目錄創建 commitlint.config.cjs 配置文件，示例配置： @commitlint/config-conventional

module.exports = {
  // 繼承的規則
  extends: ["@commitlint/config-conventional"],
  // @see: https://commitlint.js.org/#/reference-rules
  rules: {
    "subject-case": [0], // subject大小寫不做校驗

    // 類型枚舉，git提交type必須是以下類型
    "type-enum": [
      2,
      "always",
      [
    'feat', // 新增功能
        'fix', // 修復缺陷
        'docs', // 文檔變更
        'style', // 代碼格式（不影響功能，例如空格、分號等格式修正）
        'refactor', // 代碼重構（不包括 bug 修復、功能新增）
        'perf', // 性能優化
        'test', // 添加疏漏測試或已有測試改動
        'build', // 構建流程、外部依賴變更（如升級 npm 包、修改 webpack 配置等）
        'ci', // 修改 CI 配置、腳本
        'revert', // 回滾 commit
        'chore', // 對構建過程或輔助工具和庫的更改（不影響源文件、測試用例）
      ],
    ],
  },
};

添加提交信息校驗鉤子

執行下面命令生成 commint-msg 鉤子用於 git 提交信息校驗，命令來自：@commitlint/README.md

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

生成的配置如下：

Commitlint 驗證

正確的提交格式：<type>(<scope>): <subject> ，type 和 subject 默認必填

不規範的 commit msg，提交失敗	規範的 commit msg，提交成功

Commitizen & cz-git

• commitizen: 基於Node.js的 git commit 命令行工具，輔助生成標準化規範化的 commit message。--官方文檔
• cz-git: 一款工程性更強，輕量級，高度自定義，標準輸出格式的 commitizen 適配器。--官方文檔

Commitizen & cz-git 安裝

npm install -D commitizen cz-git

cz-git 配置

修改 package.json 指定使用的適配器

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

cz-git 與 commitlint 進行聯動給予校驗信息，所以可以編寫於 commitlint 配置文件之中(⇒ 配置模板)。

// commitlint.config.cjs
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: '',
  }
}

添加提交指令

package.json 添加 commit 指令

 "scripts": {
     "commit": "git-cz"
 }

cz-git 驗證

執行 commit 指令進行代碼提交流程，執行前需將改動的文件通過 git add 添加到暫存區

npm run commit

執行命令之後會出現詢問交互

根據提示一步步的完善 commit msg 信息

commit 之後 git push 推送到遠程倉庫看到提交信息效果如下：

項目源碼

完整項目源碼地址如下，如果有相關問題可以通過項目 關於我們 添加交流羣。

	Gitee	Github
倉庫地址	vue3-element-admin	vue3-element-admin