setup-guide.md

Установка и настройка проекта

Начало работы

Для подготовки проекта к работе необходимо:

1. Клонировать репозиторий
2. Открыть в терминале папку с проектом
3. Выполнить команду make setup

Все команды перечислены в Makefile, справку можно получить по команде make help.

Форматирование кода

• Используем SwiftFormat для форматирования кода
• Правила форматирования перечислены в файле .swiftformat
• Все правила можно найти тут
• Для запуска форматирования нужно в папке с проектом выполнить команду:

make format

Как это работает

1. pre-commit хук синхронизирует бейджи версий Xcode/Swift/iOS в README.md
2. pre-push хук проверяет необходимость форматирования Swift-кода
3. При нарушении правил форматирования git выдаст ошибку и подскажет команду для запуска SwiftFormat
4. Запускаем команду в терминале и выполняется форматирование кода

Как обновить SwiftFormat

Выполняем команду в терминале в папке с проектом:

make update_swiftformat

или сразу:

make update

Команда make update также автоматически обновляет версии в README.md.

Если нужно обновить только бейджи версий в README:

make update_readme_versions

Если нужно запустить только unit-тесты утилиты обновления README:

make test_readme_versions

Шпаргалка

Настройка базовых параметров приложения

Xcode -> SwiftUI-SotkaApp -> Target: SwiftUI-SotkaApp -> General

• Display Name - название приложения на экране смартфона
• Version - версия приложения для магазина
• Build - версия сборки для TestFlight