Skip to content

BUILD.md

Latest commit

 

History

History
209 lines (168 loc) · 6.45 KB

BUILD.md

File metadata and controls

209 lines (168 loc) · 6.45 KB

🔨 Инструкции по сборке и развертыванию

📦 Структура проекта

kiro-ide-cleaner/
├── 🍎 kiro_cleaner.sh           # macOS версия (Bash)
├── 🐧 kiro_cleaner_linux.sh     # Linux версия (Bash)
├── 🪟 kiro_cleaner_windows.bat  # Windows версия (Batch)
├── 🪟 kiro_cleaner_windows.ps1  # Windows версия (PowerShell)
├── 📖 README.md                 # Основная документация
├── 🔨 BUILD.md                  # Инструкции по сборке
├── 📄 LICENSE                   # MIT лицензия
└── 🚫 .gitignore               # Исключения для Git

🚀 Быстрое развертывание

Для пользователей

Скачать и запустить (macOS/Linux)

# Скачать напрямую
curl -O https://raw.githubusercontent.com/your-username/kiro-ide-cleaner/main/kiro_cleaner.sh
chmod +x kiro_cleaner.sh
./kiro_cleaner.sh

Скачать и запустить (Windows PowerShell)

# Скачать напрямую
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/your-username/kiro-ide-cleaner/main/kiro_cleaner_windows.ps1" -OutFile "kiro_cleaner.ps1"
.\kiro_cleaner.ps1

Для разработчиков

Клонирование репозитория

git clone https://github.com/your-username/kiro-ide-cleaner.git
cd kiro-ide-cleaner

🧪 Тестирование

macOS

# Проверка синтаксиса
bash -n kiro_cleaner.sh

# Тестовый запуск
echo "0" | ./kiro_cleaner.sh

Linux

# Проверка синтаксиса
bash -n kiro_cleaner_linux.sh

# Тестовый запуск
echo "0" | ./kiro_cleaner_linux.sh

Windows (PowerShell)

# Проверка синтаксиса
Get-Command .\kiro_cleaner_windows.ps1

# Тестовый запуск (требует интерактивного ввода)
.\kiro_cleaner_windows.ps1

📋 Чек-лист перед релизом

✅ Функциональность

  • Все скрипты запускаются без ошибок
  • Меню отображается корректно на всех платформах
  • Цветной вывод работает
  • Функции очистки выполняются безопасно
  • Создаются бэкапы важных файлов

✅ Совместимость

  • macOS 10.15+ (Catalina и новее)
  • Ubuntu 18.04+, Debian 10+, CentOS 7+
  • Windows 10/11
  • PowerShell 5.1+ и PowerShell Core 7+

✅ Безопасность

  • Нет жестко закодированных путей
  • Подтверждения для критических операций
  • Корректная обработка ошибок
  • Проверка прав доступа

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

  • README.md обновлен
  • Примеры использования актуальны
  • Инструкции по установке проверены
  • Лицензия указана

🔄 Процесс релиза

1. Подготовка

# Обновление версии в скриптах
sed -i 's/# Версия: .*/# Версия: 1.1/' *.sh

2. Тестирование

# Запуск тестов на всех платформах
./test_all_platforms.sh

3. Коммит и тег

git add .
git commit -m "🚀 Release v1.1: Cross-platform support"
git tag -a v1.1 -m "Version 1.1 - Added Linux and Windows support"
git push origin main --tags

4. GitHub Release

  1. Перейти в раздел Releases на GitHub
  2. Создать новый релиз с тегом v1.1
  3. Приложить файлы:
    • kiro_cleaner.sh (macOS)
    • kiro_cleaner_linux.sh (Linux)
    • kiro_cleaner_windows.bat (Windows Batch)
    • kiro_cleaner_windows.ps1 (Windows PowerShell)

🛠️ Разработка

Добавление новой функции

  1. Создать функцию в каждом скрипте:

    # macOS/Linux
step_new_feature() {
    echo -e "${PURPLE}📍 Новая функция...${NC}"
    # Логика функции
    echo -e "${GREEN}✅ Функция выполнена${NC}"
}

  2. Добавить в массив шагов:

    STEPS=(
    # ... существующие шаги
    "step_new_feature:Описание новой функции"
)

  3. Обновить справку:

    echo "• Новая функция делает что-то полезное"

Отладка

macOS/Linux

# Включить отладку
set -x
./kiro_cleaner.sh
set +x

Windows PowerShell

# Включить отладку
Set-PSDebug -Trace 1
.\kiro_cleaner_windows.ps1
Set-PSDebug -Off

📊 Метрики качества

Покрытие функций

  • ✅ Закрытие процессов: 100%
  • ✅ Удаление файлов: 100%
  • ✅ Очистка настроек: 100%
  • ✅ Бэкапы: 100%
  • ✅ Обработка ошибок: 95%

Производительность

  • ⚡ Время запуска: < 1 сек
  • ⚡ Полная очистка: < 30 сек
  • ⚡ Размер скриптов: < 20KB каждый

🤝 Вклад в проект

Требования к коду

  1. Следовать существующему стилю кодирования
  2. Добавлять комментарии для сложной логики
  3. Тестировать на всех поддерживаемых платформах
  4. Обновлять документацию

Процесс Pull Request

  1. Fork репозитория
  2. Создать ветку для функции: git checkout -b feature/new-feature
  3. Внести изменения и протестировать
  4. Создать Pull Request с описанием изменений

📞 Поддержка

При возникновении проблем с билдом:

  1. Проверить совместимость платформы
  2. Убедиться в наличии необходимых прав
  3. Создать Issue с подробным описанием проблемы