commitlint 是一个提交验证工具。原理是可以在实际的 git commit 提交到远程仓库之前使用 git 钩子来验证信息。提交不符合规则的信息将会被阻止提交到远程仓库。

    • @commitlint/cli：对commit的消息进行格式检查。
    • @commitlint/config-conventional：通用的提交规范，对应还有很多其他配置，比如angular的提交规范@commitlint/config-angular。

    安装 commitlint检查工具 以及 conventional 规范包

    1. pnpm add  @commitlint/cli @commitlint/config-conventional -D

    安装后添加配置文件.commitlintrc.js 或者 commitlint.config.js

    1. const fs = require('fs')
    2. const path = require('path')
    3. const { execSync } = require('child_process')
    5. const scopes = fs
    6.   .readdirSync(path.resolve(__dirname, 'src'), { withFileTypes: true })
    7.   .filter((dirent) => dirent.isDirectory())
    8.   .map((dirent) => dirent.name.replace(/s$/, ''))
    10. // precomputed scope
    11. const scopeComplete = execSync('git status --porcelain || true')
    12.   .toString()
    13.   .trim()
    14.   .split('\n')
    15.   .find((r) => ~r.indexOf('M  src'))
    16.   ?.replace(/(\/)/g, '%%')
    17.   ?.match(/src%%((\w|-)*)/)?.[1]
    18.   ?.replace(/s$/, '')
    20. /** @type {import('cz-git').UserConfig} */
    21. module.exports = {
    22.   ignores: [(commit) => commit.includes('init')],
    23.   // 继承的规则
    24.   extends: ['@commitlint/config-conventional'],
    25.   // 定义规则类型
    26.   rules: {
    27.     'body-leading-blank': [2, 'always'],
    28.     'footer-leading-blank': [1, 'always'],
    29.     'header-max-length': [2, 'always', 108],
    30.     'subject-empty': [2, 'never'],
    31.     'type-empty': [2, 'never'],
    32.     // subject 大小写不做校验
    33.     'subject-case': [0],
    34.     // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
    35.     'type-enum': [
    36.       2,
    37.       'always',
    38.       [
    39.         'feat',
    40.         'fix',
    41.         'perf',
    42.         'style',
    43.         'docs',
    44.         'test',
    45.         'refactor',
    46.         'build',
    47.         'ci',
    48.         'chore',
    49.         'revert',
    50.         'wip',
    51.         'workflow',
    52.         'types',
    53.         'release'
    54.       ]
    55.     ]
    56.   },
    57.   prompt: {
    58.     /** @use `yarn commit :f` */
    59.     alias: {
    60.       f: 'docs: fix typos',
    61.       r: 'docs: update README',
    62.       s: 'style: update code format',
    63.       b: 'build: bump dependencies',
    64.       c: 'chore: update config'
    65.     },
    66.     customScopesAlign: !scopeComplete ? 'top' : 'bottom',
    67.     defaultScope: scopeComplete,
    68.     scopes: [...scopes, 'mock'],
    69.     allowEmptyIssuePrefixs: false,
    70.     allowCustomIssuePrefixs: false,
    72.     // English
    73.     typesAppend: [
    74.       { value: 'wip', name: 'wip:      work in process' },
    75.       { value: 'workflow', name: 'workflow: workflow improvements' },
    76.       { value: 'types', name: 'types:    type definition file changes' }
    77.     ]
    79.       // 中英文对照版
    80.       // messages: {
    81.       //   type: '选择你要提交的类型 :',
    82.       //   scope: '选择一个提交范围 (可选):',
    83.       //   customScope: '请输入自定义的提交范围 :',
    84.       //   subject: '填写简短精炼的变更描述 :\n',
    85.       //   body: '填写更加详细的变更描述 (可选)。使用 "|" 换行 :\n',
    86.       //   breaking: '列举非兼容性重大的变更 (可选)。使用 "|" 换行 :\n',
    87.       //   footerPrefixsSelect: '选择关联issue前缀 (可选):',
    88.       //   customFooterPrefixs: '输入自定义issue前缀 :',
    89.       //   footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
    90.       //   confirmCommit: '是否提交或修改commit ?',
    91.       // },
    92.       // types: [
    93.       //   { value: 'feat', name: 'feat:     新增功能' },
    94.       //   { value: 'fix', name: 'fix:      修复缺陷' },
    95.       //   { value: 'docs', name: 'docs:     文档变更' },
    96.       //   { value: 'style', name: 'style:    代码格式' },
    97.       //   { value: 'refactor', name: 'refactor: 代码重构' },
    98.       //   { value: 'perf', name: 'perf:     性能优化' },
    99.       //   { value: 'test', name: 'test:     添加疏漏测试或已有测试改动' },
    100.       //   { value: 'build', name: 'build:    构建流程、外部依赖变更 (如升级 npm 包、修改打包配置等)' },
    101.       //   { value: 'ci', name: 'ci:       修改 CI 配置、脚本' },
    102.       //   { value: 'revert', name: 'revert:   回滚 commit' },
    103.       //   { value: 'chore', name: 'chore:    对构建过程或辅助工具和库的更改 (不影响源文件、测试用例)' },
    104.     //   { value: 'wip', name: 'wip:      正在开发中' },
    105.     //   { value: 'workflow', name: 'workflow: 工作流程改进' },
    106.     //   { value: 'types', name: 'types:    类型定义文件修改' },
    107.     // ],
    108.     // emptyScopesAlias: 'empty:      不填写',
    109.     // customScopesAlias: 'custom:     自定义',
    110.     }
    111.     }

    为了可以在每次 commit 时执行 commitlint 来 检查我们输入的 message，我们还需要用到 husky。

    使用 husky add 添加钩子，.husky文件夹下生成文件 commit-msg

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

    “$1” 在win上的终端有时候不能正确的识别，也可以直接手动添加 commit-msg 文件

    1. #!/usr/bin/env sh
    2. . "$(dirname -- "$0")/_/husky.sh"
    4. npx --no-install commitlint --edit $1

    测试一下，commit 时不加 type 会提示对应错误。
    image.png