您如何配置 commitlint 以忽略某些提交消息，例如任何包含字符串 "WIP" 的消息？

Question

我们正在使用 commitlint 对我们的提交执行命名约定，但是，我可以弄清楚如何让它忽略包含 "WIP".

的提交消息

https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-configuration.md

   /*
   * Functions that return true if commitlint should ignore the given message.
   */
  ignores?: ((message: string) => boolean)[];

这是我们当前的提交 lint 配置：

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'subject-case': [2, 'never', ['start-case', 'pascal-case']],
  },
  ignores: [],
};

添加这个的示例语法是什么？

Answer 1

语法由ignores?: ((message: string) => boolean)[];提供的类型信息给出。

您需要添加一个函数，该函数接受一个字符串参数 message，用它做一些事情，然后 returns 一个布尔值。一个例子：

ignores: [
    (message) => message.includes('WIP')
]

这将添加一个函数，如果消息中的任何地方有 WIP，returns true，导致它被忽略。

您如何配置 commitlint 以忽略某些提交消息，例如任何包含字符串 "WIP" 的消息？

How do you configure commitlint to ignore certain commit messages such as any that contain the string "WIP"?

git

lint