commitlint

Начните | Веб -сайт

LINT COMMEST сообщений

Демо, генерируемая с помощью SVG-CLI

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• Быть хорошим commitizen

• Поделиться конфигурацией через npm

• Нажмите на conventional-changelog

Содержимое

• Начните | Веб -сайт

• Установить и запустить

• Выпуски

• Преимущества использования Commitlint

• Содержимое

• Что такое Commitlint

• Начиная

• Кли

• Конфигурация

• Общая конфигурация

• Документация

• API

• Инструменты

• Дорожная карта

• Поддержка версии и выбросы

• Связанные проекты

• Лицензия

• Разработка

---

Что такое Commitlint

Проверяет Commitlint, если ваши сообщения о коммите соответствуют обычному формату коммита.

В общем, шаблон в основном выглядит так:

 Тип (Scope?): Субъект #Scope является необязательным; Поддерживается несколько областей (текущие варианты разделителей: "/", "" и ",")

Примеры реального мира могут выглядеть так:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Общие типы в соответствии с Commitlint-Config-Conventional (на основе угловой соглашения) могут быть:

• строить

• рутинная работа

• CI

• док

• подвиг

• исправить

• перфу

• рефактор

• возвращаться

• стиль

• тест

Они могут быть изменены вашей собственной конфигурацией.

Преимущества использования Commitlint

• Зачем использовать обычные коммиты?

• «Полученные пособия на соглашениях» (Sall Slides)

Начиная

• Локальная настройка - сообщения о коммите с Husky

• CI Setup - сообщества LINT во время сборки CI

Кли

• Основной способ взаимодействия с Commitlint.

• npm install --save-dev @commitlint/cli

• Пакеты: CLI

Конфигурация

• Конфигурация поднимается из:

• .commitlintrc

• .commitlintrc.json

• .commitlintrc.yaml

• .commitlintrc.yml

• .commitlintrc.js

• .commitlintrc.cjs

• .commitlintrc.mjs

• .commitlintrc.ts

• .commitlintrc.cts

• commitlint.config.js

• commitlint.config.cjs

• commitlint.config.mjs

• commitlint.config.ts

• commitlint.config.cts

• Поле commitlint в package.json

• Поле commitlint в package.yaml

• Пакеты: CLI, ядро

• См. Правила полного списка возможных правил

• Пример конфигурации можно найти на @commitlint/config-conventional

Общая конфигурация

Ряд общих конфигураций доступен для установки и использования с commitlint :

• @Commitlint/Config-Angular

• @Commitlint/Config-Conventional

• @Commitlint/config-lerna-scopes

• @commitlint/config-nx-scopes

• @commitlint/confign-patternplate

• Обычный-чаголог-линт-конфиг-атом

• Традиционно-черно-линтный-конфиг-канонический

️ Если вы хотите опубликовать свою собственную общую конфигурацию, убедитесь, что у него есть имя, согласованное с шаблоном commitlint-config-emoji-log или commitlint-config-your-config-name -тогда в расширении все, что вам нужно написать,-это emoji-log Или your-config-name .

Документация

Проверьте основной веб -сайт.

API

• Альтернативный, программный способ взаимодействия с commitlint

• Пакеты:

• Формат - отчеты о коммуникации формата

• Lint - Lint a String против правил Commitlint

• загрузка - загрузка общей конфигурации коммитации

• Читать - прочитать сообщения о коммит из указанного диапазона или последнее редактирование

• См. API для полного списка методов и примеров

Инструменты

• Адаптер коммитировки

• быстрый

Дорожная карта

commitlint считается стабильной и используется в различных проектах в качестве инструмента разработки.

Идеи : Обычный Человек/Коммит № 94

Поддержка версии и выбросы

• Node.js lts >= 18

• git >= 2.13.2

Выпуски

Патчи безопасности будут применены к версиям, которые еще не являются EOL.
Функции будут применяться только к текущей основной версии.

Выпускать	Первоначальный выпуск
v19	02/2024
v18	10/2023

EOL обычно через год.

Мы не спонсируемый проект OSS. Поэтому мы не можем пообещать своевременно выпустить патч -версии для более старых выпусков.
Если вы застряли на более старой версии и нуждаетесь в патче безопасности, мы счастливы, если вы можете предоставить PR.

Связанные проекты

• Обычный Changelog генерирует изменение от обычной истории коммита

• Commerizen Простые конвенции для граждан в Интернете

• Create-Semantic Module CLI для быстрого интеграции Commerizen и Commitlint в новые или существующие проекты

Лицензия

Авторские права @marionebl. Все пакеты commitlint выпускаются по лицензии MIT.

Разработка

commitlint разрабатывается в репозитории Mono.

Установить и запустить

 git clone [email protected]: обычный changelog/commitlint.gitcd commitlint
пряжа
пряжа Run Build # Run Build Tasksyarn Start # Run Tests, опять же, на изменении запуска Commitlint # CLI CLI

Для получения дополнительной информации о том, как внести свой вклад, посмотрите на наше руководство по взносу.