自定义 commitlint 标头格式

Question

我正在使用 Husky 设置我的 git 挂钩，并尝试更改为 Commitlint 预期的默认标头格式：

type(scope?): subject

我特别想采用这种格式：

:gitmoji:? [scope] subject

:gitmoji: 是Gitmoji 的表情符号之一并且是可选的，在范围周围使用方括号（而不是可选）而不是括号，并且没有 : 将类型 + 范围与学科。此外，我希望 scope 具有类似于 TCKT-666 的格式（例如，引用 Jira 的票证），

目前，我一直在尝试使用来自commitlint.config.js 的parserPreset、parserOpts、headerPattern 和headerCorrespondence 属性，但遇到了几个问题：

• headerPattern 正则表达式似乎完全被忽略了，我得到的所有错误都来自我在commitlint.config.js 中设置的规则 - 所以我无法为我的scope 设置特定格式（尽管commitlint-plugin-function-rules 可能帮助）
• 我完全不知道如何在类型之后删除对 : 的需要，或者如何用范围周围的方括号替换括号

Answer 1

这应该适用于:gitmoji:? [scope] subject

module.exports = {
  parserPreset: {
    parserOpts: {
      headerPattern: /^(?:(:\w+:)\s)?\[(\w+)\] (.+)/,
      headerCorrespondence: ["type", "scope", "subject"],
    },
  },
  plugins: [
    {
      rules: {
        "header-match-team-pattern": (parsed) => {
          const { type, scope, subject } = parsed;
          if (type === null && scope === null && subject === null) {
            return [
              false,
              "header must be in format ':gitmoji:? [scope] subject'",
            ];
          }
          return [true, ""];
        },
        "gitmoji-type-enum": (parsed, _when, expectedValue) => {
          const { type } = parsed;
          if (type && !expectedValue.includes(type)) {
            return [
              false,
              `type must be one of ${expectedValue}
    see https://gitmoji.dev`,
            ];
          }
          return [true, ""];
        },
      },
    },
  ],
  rules: {
    // "type-empty": [2, "never"],
    "header-match-team-pattern": [2, "always"],
    "gitmoji-type-enum": [2, "always", [":bug:", ":sparkle:"]], // custom rule defined in plugins
    // "subject-case": [2, "always", "sentence-case"],
  },
};

---

看起来需要有一个像header-match-team-pattern 这样的自定义规则来确保 RegExp 匹配。