create-vg-start-template

Мини‑CLI для быстрого развёртывания темы на основе kits-starter-theme.

Usage

• Создать проект: npx create-vg-start-template my-theme
• Опции:
  • --repo <url>: Git URL репозитория шаблона (по умолчанию [email protected]:VICTORY-digital/kits-starter-theme.git)
  • --pm <npm|pnpm|yarn>: менеджер пакетов (по умолчанию npm)
  • --no-install: пропустить установку зависимостей
  • --no-git: не инициализировать новый Git‑репозиторий
  • --allow-degit: разрешить fallback на npx degit (только для публичных HTTPS репозиториев)
  • Переменная окружения: VG_TEMPLATE_REPO — задаёт приватный URL по умолчанию
• Доступ к приватному шаблону: требуется SSH‑доступ к GitHub‑репозиторию (например, [email protected]:VICTORY-digital/kits-starter-theme.git). Без доступа команда завершится ошибкой (контент не раскроется).

Что делает CLI

• Клонирует шаблон (git clone --depth=1; если git недоступен — через npx degit при флаге --allow-degit и только для публичных HTTPS репозиториев)
• Удаляет .git, правит package.json:name и заголовок style.css (Theme Name)
• Запускает установку зависимостей (npm install → сработает postinstall с Composer)
• Инициализирует новый Git‑репозиторий (можно отключить флагом)

Безопасность и приватность

• Сам CLI может быть публичным в npm — доступ к приватному шаблону ограничивается правами GitHub.
• Клонирование идёт по SSH. Если у пользователя нет доступа к приватному репозиторию, клонирование завершится ошибкой, содержимое не выдаётся.
• Для публичных репозиториев доступен деградационный режим --allow-degit (по умолчанию выключен для приватности).

Публикация в npm

1. В packages/create-vg-start-template/package.json проверьте name.
2. Авторизуйтесь: npm login
3. Опубликуйте: npm publish --access public
4. Готово: npx create-vg-start-template my-theme

Примечание

• Для приватного шаблона используйте SSH‑URL ([email protected]:<org>/<repo>.git) или задайте VG_TEMPLATE_REPO.
• Все, кто запускает CLI, должны иметь доступ к приватному репозиторию (SSH ключ или GitHub login/token).