1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/vcs-all-in-one-commitlint

Клонировать/Скачать
reference-rules.md 9.8 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 30.06.2025 17:53 4eb1e0e

Правила

Правила состоят из имени и массива конфигурации. Массив конфигурации содержит:

  • Уровень [0..2]: 0 отключает правило. Для 1 оно будет считаться предупреждением, для 2 — ошибкой.
  • Применимо always|never: never инвертирует правило.
  • Значение: значение, используемое для этого правила.

Конфигурации правил могут быть либо массивом, расположенным в ключе с именем правила в объекте rules, либо функцией, возвращающей тип array или Promise<array>. Это означает, что поддерживаются все следующие обозначения.

Простой массив

  "rules": {
    "header-max-length": [0, "always", 72],
  }

Функция, возвращающая массив

  "rules": {
    "header-max-length": () => [0, "always", 72],
  }

Асинхронная функция, возвращающая массив

  "rules": {
    "header-max-length": async () => [0, "always", 72],
  }

Функция, возвращающая промис, разрешающийся в массив

  "rules": {
    "header-max-length": () => Promise.resolve([0, "always", 72]),
  }

Доступные правила

body-leading-blank

  • Условие: body начинается с пустой строки
  • Правило: always

body-max-length

  • Условие: body имеет value или меньше символов
  • Правило: always
  • Значение
Infinity

body-max-line-length

  • Условие: строки в body имеют value или меньше символов
  • Правило: always
  • Значение
Infinity

body-min-length

  • Условие: body имеет value или больше символов
  • Правило: always
  • Значение
0

footer-leading-blank

  • Условие: footer начинается с пустой строки
  • Правило: always

footer-max-length

  • Условие: footer имеет value или меньше символов
  • Правило: always
  • Значение
Infinity

footer-max-line-length

  • Условие: строки в footer имеют value или меньше символов
  • Правило: always
  • Значение
Infinity

footer-min-length

  • Условие: footer имеет value или больше символов
  • Правило: always
  • Значение
0

header-case

  • Условие: header находится в регистре value
  • Правило: always
'lowerCase'
  • Возможные значения
[
  'lower-case', // по умолчанию
  'upper-case', // UPPERCASE
  'camel-case', // camelCase
  'kebab-case', // kebab-case
  'pascal-case', // PascalCase
  'sentence-case', // Предложение с заглавной буквы
  'snake-case', // snake_case
  'start-case' // С заглавной буквы каждого слова
]

header-full-stop

  • Условие: header заканчивается на value
  • Правило: never
  • Значение
'.'

header-max-length

  • Условие: header имеет value или меньше символов
  • Правило: always
  • Значение
72

header-min-length

  • Условие: header имеет value или больше символов
  • Правило: always
  • Значение
0

references-empty

  • Условие: references имеет хотя бы одну запись
  • Правило: never

scope-enum

  • Условие: scope найден в значении
  • Правило: always
  • Значение
    []

scope-case

  • Условие: scope находится в регистре value
  • Правило: always
'lowerCase'
  • Возможные значения
[
  'lower-case', // по умолчанию
  'upper-case', // UPPERCASE
  'camel-case', // camelCase
  'kebab-case', // kebab-case
  'pascal-case', // PascalCase
  'sentence-case', // Предложение с заглавной буквы
  'snake-case', // snake_case
  'start-case' // С заглавной буквы каждого слова
]

scope-empty

  • Условие: scope пустой
  • Правило: never

scope-max-length

  • Условие: scope имеет value или меньше символов
  • Правило: always
  • Значение
Infinity

scope-min-length

  • Условие: scope имеет value или больше символов
  • Правило: always
  • Значение
0

subject-case

  • Условие: subject находится в регистре value
  • Правило: always
'lowerCase'
  • Возможные значения
[
  'lower-case', // по умолчанию
  'upper-case', // UPPERCASE
  'camel-case', // camelCase
  'kebab-case', // kebab-case
  'pascal-case', // PascalCase
  'sentence-case', // Предложение с заглавной буквы
  'snake-case', // snake_case
  'start-case' // С заглавной буквы каждого слова
]

subject-empty

  • Условие: subject пустой
  • Правило: never

subject-full-stop

  • Условие: subject заканчивается на value
  • Правило: never
  • Значение
'.'

subject-max-length

  • Условие: subject имеет value или меньше символов
  • Правило: always
  • Значение
Infinity

subject-min-length

  • Условие: subject имеет value или больше символов
  • Правило: always
  • Значение
0

type-enum

  • Условие: type найден в значении
  • Правило: always
  • Значение
    ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'revert']

type-case

  • Описание: type находится в регистре value
  • Правило: always
  • Значение
    'lower-case'
  • Возможные значения
[
  'lower-case', // по умолчанию
  'upper-case', // UPPERCASE
  'camel-case', // camelCase
  'kebab-case', // kebab-case
  'pascal-case', // PascalCase
  'sentence-case', // Предложение с заглавной буквы
  'snake-case', // snake_case
  'start-case' // С заглавной буквы каждого слова
];

type-empty

  • Условие: type пустой
  • Правило: never

type-max-length

  • Условие: type имеет value или меньше символов
  • Правило: always
  • Значение
Infinity

type-min-length

  • Условие: type имеет value или больше символов
  • Правило: always
  • Значение
0

signed-off-by

  • Условие: message содержит value
  • Правило: always
  • Значение
'Signed-off-by:'

Устаревшие правила

body-tense deprecated

  • Условие: body выражен в виде глагола в виде времени, указанного в значении value
  • Правило: always
  • Значение
['present-imperative']
  • Возможные значения
[
  'past-tense', // прошедшее время (did)
  'present-imperative', // повелительное наклонение (do)
  'present-participle', // причастие настоящего времени (doing)
  'present-third-person' // настоящее время третьего лица (does)
]

footer-tense deprecated

  • Условие: footer выражен в виде глагола в виде времени, указанного в значении value
  • Правило: always
  • Значение
['present-imperative']
  • Возможные значения
[
  'past-tense', // прошедшее время (did)
  'present-imperative', // повелительное наклонение (do)
  'present-participle', // причастие настоящего времени (doing)
  'present-third-person' // настоящее время третьего лица (does)
]

lang deprecated

  • Условие: язык в subject соответствует значению value
  • Правило: always
  • Значение
eng

subject-tense deprecated

  • Условие: subject выражен в виде глагола в виде времени, указанного в значении value
  • Правило: always
  • Значение
['present-imperative']
  • Возможные значения
[
  'past-tense', // прошедшее время (did)
  'present-imperative', // повелительное наклонение (do)
  'present-participle', // причастие настоящего времени (doing)
  'present-third-person' // настоящее время третьего лица (does)
]

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/vcs-all-in-one-commitlint.git
git@api.gitlife.ru:oschina-mirror/vcs-all-in-one-commitlint.git
oschina-mirror
vcs-all-in-one-commitlint
vcs-all-in-one-commitlint
master