Proton VPN для iOS и macOS

Авторское право (c) 2025 Proton Technologies AG

Зависимости

Этот проект использует Swift Package Manager для всех своих зависимостей. Позвольте Xcode разрешить пакеты перед запуском любой цели.

Сторонние зависимости

ACKNOWLEDGEMENTS.md

Настройка

• Включите Git LFS на вашем компьютере
• Клонируйте этот репозиторий
• Убедитесь, что вы клонируете подмодули (git submodule init + git submodule update)
• Установите зависимости Homebrew с помощью brew bundle
• Вам понадобится использовать Xcode 14.x на данный момент
• Настройте подпись кода для всех целей с помощью платной учётной записи разработчика Apple (требуется из-за привилегий VPN) и измените идентификаторы бандла на уникальные
• Очистите папку сборки в Xcode (Cmd+Shift+K)

Обфусцированные константы

Для сборки проекта требуется набор секретов. Они включают URL-адреса и ключи и хранятся в файлах с именем ObfuscatedConstants.swift. Эти файлы хранятся в отдельном репозитории, что требует некоторых дополнительных действий для поддержания синхронизации.

Сначала запустите скрипт, расположенный в Integration/Scripts/credentials.sh, с командой setup. Укажите путь, по которому вы хотите клонировать репозиторий секретов локально, с помощью аргумента -p, и URL репозитория с помощью аргумента -r.

./Integration/Scripts/credentials.sh setup -p <path to credentials repo> -r <credentials remote>

Затем, чтобы убедиться, что настройка прошла успешно:

./Integration/Scripts/credentials.sh checkout

При правильной настройке обфусцированные константы будут автоматически синхронизироваться во время фазы сборки Generate Obfuscated Constants каждого приложения.

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

Проект упакован по слоям, чтобы избежать ада модульных зависимостей:

• Foundations: небольшие библиотеки одного назначения для создания более крупных вещей. Они должны связываться только друг с другом, если вообще связываются.
• Shared: библиотеки немного крупнее, предназначенные для обмена кодом между приложениями или расширениями. Части этой библиотеки, которые становятся слишком большими или которым выгодно быть отдельным модулем, могут быть вынесены в Foundations. Они должны связываться только с библиотеками Foundations, за возможным исключением связи каждой из этих библиотек с CoreCommon.
• Features: автономные библиотеки, содержащие одну функцию. Эти библиотеки должны связываться только с библиотеками из категорий Shared или Foundations. Они включаются и инстанцируются в коде приложений, тестов или расширений.

Добавления нового кода/функций в LegacyCommon и NEHelper следует по возможности избегать. Эти пакеты следует постепенно разбирать, чтобы разместить их компоненты в новых/существующих пакетах из трёх указанных выше категорий.

Проверка кода (linting)

Во время разработки swiftlint запускается в нестрогом режиме, чтобы легче было разрабатывать, не беспокоясь о форматировании кода. На CI проверка строгая и завершится ошибкой при любом предупреждении. Перед фиксацией кода в этом репозитории выполните следующий скрипт, чтобы добавить pre-commit хук, который будет проверять все новые/изменённые файлы в строгом режиме и помешает вам зафиксировать код, который не пройдёт CI.

./Integration/Scripts/pre_commit_lint.sh setup

Локализация

Приложение использует SwiftGen для генерации файла Localizable.strings для доступа ко всем строкам приложения, хранящимся в стандартных файлах Localizable.strings. Просто добавьте новую строку в пакет Strings и выполните команду swiftgen в каталоге, где определён swiftgen.yml.

Лицензия

Код и файлы данных в этом дистрибутиве лицензируются на условиях GPLv3, опубликованной Free Software Foundation. Копию этой лицензии см. на https://www.gnu.org/licenses/.

Авторское право (c) 2025 Proton Technologies AG