commitlint自定义规则

要自定义 commitlint 的规则，你需要在项目中配置 commitlint.config.js 文件。这个文件定义了 commitlint 的配置项和规则。

下面是一个示例的 commitlint.config.js 文件：

module.exports = {
  rules: {
    // 自定义规则名称
    'custom-rule': (parsed, when) => {
      // 判断是否满足规则
      if (parsed.commit.message.startsWith('CustomRule')) {
        return [true, 'Custom rule passed'];
      } else {
        return [false, 'Custom rule failed'];
      }
    },
  },
};

在上面的示例中，我们自定义了一个名为 'custom-rule' 的规则。它会检查提交的消息是否以 'CustomRule' 开始。如果满足规则，返回一个通过的结果；否则返回一个失败的结果。

你可以根据自己的需求定义更多的规则，例如检查提交消息的长度、格式等。

相关问题

commitlint 和 commitlint 的配置

`commitlint`是一个用于限制Git提交消息格式的工具，它可以帮助团队保持一致的提交规范，提高代码审查效率。它通过预定义的规则检查提交信息，并在不符合规则时阻止提交。`commitlint`通常配合`husky`这个Node.js库一起使用，作为Git钩子在每次提交前运行。

要配置`commitlint`，首先需要安装它和相关的依赖：

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

然后，你会看到`@commitlint/config-conventional`已经被安装并提供了一套默认的规则。这个配置基于Angular项目的约定，但你可以自定义规则或者创建自己的`.commitlintrc`文件来调整格式。`.commitlintrc`通常会包含两个部分：`extends`和`rules`。

`extends`部分指定继承的规则集，例如：

{
  "extends": ["conventional-commit", "angular"]
}

这表示将遵循Angular项目和Conventional Commits标准。

`rules`部分允许你修改或添加特定规则，例如更改标题大小写、规定Body的部分等。如果想自定义，可以添加如下的内容：

{
  "rules": {
    "body-max-line-length": [2, "always", 80],
    "header-max-length": [2, "never", 50]
  }
}

这里设置了最大行长度和标题的最大字符数。

使用`commitlint`命令可以直接验证提交信息是否符合规则：

commitlint --edit

这会在终端中打开一个编辑器让你输入或修改提交信息，直到符合规则。

commitlint 小乌龟

### Commitlint 配置与使用

Commitlint 是一款用于验证 Git 提交信息是否符合特定规则的工具。通过配置文件，可以定义提交消息应该遵循哪些格式和风格指南。

#### 安装 Commitlint

为了安装 Commitlint 并设置基本配置，在命令行执行如下指令：

npm install --save-dev @commitlint/{config-conventional,cli}

接着创建 `commitlint.config.js` 文件来指定使用的预设规则集：

module.exports = {
  extends: ['@commitlint/config-conventional']
};

此配置会应用常规惯例（Conventional Commits），这是一种广泛接受的标准[^1]。

#### 使用小乌龟 (TortoiseGit) 进行本地提交校验

虽然 TortoiseGit 主要是一个图形化的 Git 操作界面，并不直接提供内置支持 commitlint 功能，但是可以通过自定义钩子(hooks) 来集成 commitlint 到工作流中。具体做法是在 `.git/hooks/pre-commit` 或者其他合适的 hook 中调用 commitlint 命令来进行提交前的消息检查。

对于 Windows 用户来说，可以在 TortoiseGit 设置中的 "Hooks" 页面添加一个新的脚本作为 pre-push 或 pre-commit Hook:

npx --no-install commitlint --edit || exit 1

这段 PowerShell 脚本会在每次尝试推送之前自动运行 commitlint 对即将被推送到远程仓库的新提交进行审查；如果发现不符合规定的提交，则阻止操作继续直到修正为止[^2]。

#### 关于小乌龟插件的支持情况

需要注意的是，目前并没有专门为 TortoiseGit 设计用来配合 commitlint 的官方插件。不过上述提到的方法已经能够很好地满足日常开发需求——即利用现有的 Git Hooks 结合 NPM Script 实现自动化检验机制而不必依赖额外软件扩展功能[^3]。