Как вы конфигурируете commitlint, чтобы игнорировать определенные сообщения о коммитах, например, содержащие строку «WIP»? - PullRequest
Новая
       16

Как вы конфигурируете commitlint, чтобы игнорировать определенные сообщения о коммитах, например, содержащие строку «WIP»?

1 голос
/ 12 февраля 2020

Мы используем 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: [],
};

Какой пример синтаксиса для добавления этого?

1 Ответ

0 голосов
/ 12 февраля 2020

Синтаксис задается информацией о типе, предоставленной ignores?: ((message: string) => boolean)[];.

Вам нужно добавить функцию, которая принимает строковый аргумент message, что-то с ним делает, а затем возвращает логическое значение. Пример: 

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

Это добавит функцию, которая возвращает true, если сообщение содержит WIP где-либо в нем, вызывая его игнорирование.

...