gitverse-release 3.2.0 → 3.3.1

package/README.md

@@ -15,6 +15,8 @@
 - 🏷️ **Автоматические git теги и коммиты**
 - 🔍 **Режим dry-run** для безопасного тестирования
 - ⚙️ **Гибкая конфигурация** через `.gitversereleaserc.json`
+- 🔧 **Автогенерация commitlint конфига** из release конфигурации
+- 🪝 **Хуки beforeCommit** для автоматической подготовки файлов перед релизом
 
 ## Установка
 
@@ -224,6 +226,88 @@ git commit -m "fix(ui): исправлена ошибка компонента"
 git commit -m "chore: обновлены зависимости"
 ```
 
+## Генерация Commitlint конфига
+
+Инструмент может автоматически генерировать `commitlint.config.ts` из вашей release конфигурации, обеспечивая синхронизацию между форматом коммитов и генерацией релизов.
+
+### Быстрый старт
+
+```bash
+# Генерировать commitlint конфиг
+npx gitverse-release generate-commitlint
+
+# Preview без записи файла
+npx gitverse-release generate-commitlint --dry-run
+
+# С кастомными параметрами
+npx gitverse-release generate-commitlint --format js --output .commitlintrc.js
+```
+
+### Что генерируется?
+
+Команда автоматически извлекает:
+- **Типы коммитов** из `changelog.types` (feat, fix, docs, etc.)
+- **Scopes** из названий пакетов в монорепо + дополнительные scopes
+- **Правила валидации** (max length, case, required fields)
+
+### Конфигурация defaults
+
+Добавьте секцию `commitlint` в `.gitversereleaserc.json`:
+
+```json
+{
+  "commitlint": {
+    "output": "commitlint.config.ts",
+    "format": "ts",
+    "scopes": ["deps", "ci", "docs"],
+    "scopeRequired": false,
+    "headerMaxLength": 100,
+    "comments": true
+  }
+}
+```
+
+Теперь можно просто запускать `npx gitverse-release generate-commitlint` без параметров!
+
+### CLI опции
+
+```bash
+--output <path>          Путь для вывода (default: из конфига)
+--format <ts|js|json>    Формат файла (default: из конфига)
+--scopes <list>          Дополнительные scopes через запятую
+--scope-required         Требовать обязательный scope
+--header-max-length <n>  Максимальная длина header
+--no-comments            Отключить комментарии в файле
+--dry-run                Preview без записи
+--verbose                Подробный вывод
+```
+
+### Примеры использования
+
+```bash
+# Использовать настройки из конфига
+npx gitverse-release generate-commitlint
+
+# Preview сгенерированного файла
+npx gitverse-release generate-commitlint --dry-run --verbose
+
+# Генерировать JS вместо TS
+npx gitverse-release generate-commitlint --format js --output .commitlintrc.js
+
+# Добавить дополнительные scopes
+npx gitverse-release generate-commitlint --scopes api,cli,tests
+
+# Требовать обязательный scope
+npx gitverse-release generate-commitlint --scope-required
+```
+
+### Преимущества
+
+✅ **Единый источник истины** - типы и scopes определяются в одном месте
+✅ **Автоматическая синхронизация** - изменения в release конфиге автоматически отражаются в commitlint
+✅ **Меньше ошибок** - нет риска рассинхронизации конфигов
+✅ **CI-friendly** - легко интегрируется в pipelines для проверки актуальности конфига
+
 ## Конфигурация
 
 ### Полный пример
@@ -231,6 +315,7 @@ git commit -m "chore: обновлены зависимости"
 ```json
 {
   "git": {
+    "beforeCommit": "bun run lint:fix",
     "commitMessage": "chore(release): v{version} [skip ci]",
     "tagMessage": "Release {version}",
     "push": true,
@@ -265,10 +350,54 @@ git commit -m "chore: обновлены зависимости"
   "monorepo": {
     "enabled": false,
     "packages": []
+  },
+  "commitlint": {
+    "output": "commitlint.config.ts",
+    "format": "ts",
+    "scopes": ["deps", "ci", "docs"],
+    "scopeRequired": false,
+    "headerMaxLength": 100,
+    "comments": true
+  }
+}
+```
+
+### beforeCommit хук
+
+Хук `beforeCommit` запускается **перед проверкой чистоты working tree** и позволяет автоматически подготовить файлы перед созданием релиза:
+
+```json
+{
+  "git": {
+    "beforeCommit": "bun run lint:fix"
   }
 }
 ```
 
+**Как это работает:**
+1. Запускается команда `beforeCommit` (например, линтер)
+2. Если команда выполнилась успешно (exit code 0):
+   - Все измененные файлы добавляются в staging area (`git add -A`)
+   - Эти изменения войдут в коммит релиза вместе с version/changelog
+3. Проверяется чистота working tree (только unstaged изменения)
+
+**Примеры использования:**
+```json
+// Форматирование кода
+"beforeCommit": "bun run format"
+
+// Линтинг и автофикс
+"beforeCommit": "bun run lint:fix"
+
+// Обновление lock файлов
+"beforeCommit": "bun install --frozen-lockfile=false"
+
+// Несколько команд
+"beforeCommit": "bun run lint:fix && bun run format"
+```
+
+**Важно:** Если хук завершается с ошибкой (exit code ≠ 0), изменения НЕ добавляются в staging area и релиз продолжается как обычно.
+
 ### Переменные окружения
 
 ```bash
@@ -332,19 +461,53 @@ env:
 
 ## CLI опции
 
-```
+### Основные команды
+
+```bash
+# Создать релиз
 npx gitverse-release [package] [options]
 
+# Генерировать commitlint конфиг
+npx gitverse-release generate-commitlint [options]
+
+# Создать только GitVerse Release для существующего тега (recovery mode)
+npx gitverse-release create-only --tag <tag> [--package <name>]
+```
+
+### Опции для релиза
+
+```
 Аргументы:
   package              Имя пакета для релиза (для монорепозиториев)
 
 Опции:
   --dry-run            Запуск без внесения изменений
+  --config <path>      Путь к конфиг файлу (default: .gitversereleaserc.json)
+  --package <name>     Имя пакета для релиза (для монорепо)
   --version <version>  Указать конкретную версию
-  --skip-git-check     Пропустить проверку git статуса
+  --prerelease [tag]   Создать prerelease версию (beta, alpha, rc)
+  --no-commit          Не создавать git коммит
+  --no-tag             Не создавать git тег
+  --no-push            Не пушить в remote
+  --no-release         Не создавать GitVerse Release
+  --verbose            Подробный вывод
   --help               Показать справку
 ```
 
+### Опции для generate-commitlint
+
+```
+Опции:
+  --output <path>            Путь для вывода (default: commitlint.config.ts)
+  --format <ts|js|json>      Формат файла (default: ts)
+  --scopes <scopes>          Дополнительные scopes (comma-separated)
+  --scope-required           Требовать обязательный scope
+  --header-max-length <n>    Максимальная длина header (default: 100)
+  --no-comments              Отключить комментарии в файле
+  --dry-run                  Preview без записи
+  --verbose                  Подробный вывод
+```
+
 ## CI/CD интеграция
 
 ### GitVerse Actions
@@ -434,7 +597,7 @@ MIT © [RainyPixel](https://gitverse.ru/RainyPixel)
 
 ## Сообщить об ошибке
 
-Создайте issue на [GitVerse](https://gitverse.ru/RainyPixel/gitverse-sdk/issues)
+Создайте issue на [GitVerse](https://gitverse.ru/RainyPixel/gitverse-sdk/tasktracker)
 
 ---