Форматер сообщений Conventional Commits
Создавайте сообщения Conventional Commits в соответствии со спецификацией из типа, области и описания, или вставьте существующее сообщение коммита, чтобы разбить его на части. Отслеживает предел в 72 символа для строки темы и автоматически добавляет нижний колонтитул BREAKING CHANGE.
Ввод
Необязательная область кодовой базы, затронутая этим изменением.
Краткое резюме в повелительном наклонении, без точки в конце.
Вывод
| Проверка | Результат |
|---|---|
| No data yet | |
Другие способы использовать этот инструмент
REST API
curl -X POST https://api.iotools.cloud/v1/tool/conventional-commit-message-formatter \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mode": "build",
"type": "feat",
"scope": "auth",
"description": "add OAuth2 login support",
"breaking": "true",
"breakingDescription": "The login() function now requires an options obj…",
"body": "Implements the OAuth2 authorization code flow us…",
"footers": "Refs: #482"
}'Подставьте свой собственный ключ из аккаунта. Поля инструмента — это тело запроса, без обёртки.
Спросите у ИИ-агента
Use the IOTools `conventional-commit-message-formatter` tool (Conventional Commit Message Formatter) on this input:
YOUR_INPUT_HEREВставьте это любому агенту, подключённому к MCP-серверу IOTools, и добавьте свой ввод.
Виджет для встраивания
<iframe
src="https://iotools.cloud/embed/conventional-commit-message-formatter/"
width="100%" height="520" frameborder="0" scrolling="no" loading="lazy"
title="Форматер сообщений Conventional Commits — iotools.cloud"
sandbox="allow-scripts allow-forms allow-same-origin allow-downloads allow-popups allow-popups-to-escape-sandbox"
allow="clipboard-write"
style="width:100%;border:1px solid #e5e7eb;border-radius:12px;overflow:hidden"></iframe>
<script src="https://iotools.cloud/embed.js" async></script>Вставьте это на свою страницу — бесплатно, без ключа, нужна лишь обратная ссылка.
| Стоимость вызова API/MCP | От 5 кредитов |
|---|---|
| Нужно больше кредитов? | Посмотреть тарифы |
Также доступно через
Руководства
Conventional Commits — это строгий,
машинобразный формат для сообщений коммитов: тип, необязательная область,
краткое описание и необязательные разделы тела/нижних колонтитулов. Инструменты
вроде commitlint, semantic-release и автоматические генераторы истории
изменений — все они разбирают эту точную форму — один неправильный символ
(отсутствует двоеточие, лишний пробел, неправильный синтаксис нижнего колонтитула)
и коммит молча не пройдет валидацию или будет пропущен из истории изменений. Эта
инструмент создает сообщение, соответствующее спецификации, из формы, поэтому
формат всегда правильный, и может также разобрать существующее сообщение обратно
на его части. Все работает в вашем браузере.
Как использовать
- Выберите Создать сообщение.
- Выберите Тип (
feat,fix,docs, …) и, при необходимости, Область (область кодовой базы, затронутая изменением, например,apiилиparser). - Напишите краткое Описание в повелительном наклонении ("добавить", а не "добавлено").
- Установите флажок Критическое изменение, если коммит нарушает обратную
совместимость, и опишите нарушение — оно будет добавлено как нижний колонтитул
BREAKING CHANGE:и!после типа/области, в точности как требует спецификация. - Добавьте необязательное Тело для более подробного объяснения и
Нижние колонтитулы для таких вещей, как
Refs: #123илиReviewed-by: Name(один за строкой). - Скопируйте отформатированное сообщение прямо в
git commit -m "..."или в окно сообщения коммита вашего редактора.
Переключитесь на Разобрать сообщение для обратного: вставьте существующее сообщение коммита и инструмент разберет его обратно на тип, область, флаг критического изменения, описание, тело и нижние колонтитулы — полезно для проверки того, действительно ли сообщение, написанное кем-то другим, соответствует спецификации.
Длина строки темы
Таблица проверки строки темы отслеживает ваш отформатированный заголовок
(тип(область)!: описание) в сравнении с часто используемым пределом в 72
символа, поэтому длинные строки темы, которые будут обрезаны в git log --oneline
или в списке коммитов GitHub, перехватываются перед тем, как вы сделаете коммит.
Типы коммитов
feat и fix прямо соответствуют бампам семантических версий в
Semantic Versioning, когда инструмент типа semantic-release
читает вашу историю, а нижний колонтитул BREAKING CHANGE (или !) вызывает
бамп версии major независимо от типа. Остальные — docs, style, refactor,
perf, test, chore, ci, build, revert — описывают изменение без влияния
на номер версии.
Это заменяет хук коммита, как commitlint?
Нет — commitlint проверяет коммиты во время коммита (обычно через Git хук) и предназначен для автоматического выполнения в рабочем процессе команды. Эта инструмент предназначена для написания одного сообщения вручную или проверки сообщения перед вставкой. Используйте обе: эту для составления сообщения, commitlint для автоматического применения правила.
Что если мне нужно просмотреть всю историю коммитов вместо одного сообщения?
Используйте Git Log Formatter / Prettifier для
преобразования выходных данных git log в таблицу, список или JSON — или
Git Cheatsheet для распространенных команд Git.