Proton VPN pour iOS et macOS

Dépendances

Ce projet utilise Swift Package Manager pour toutes ses dépendances. Autorisez Xcode à résoudre les packages avant d'exécuter une cible quelconque.

Dépendances tierces

ACKNOWLEDGEMENTS.md

Configuration

Activez Git LFS sur votre machine
Clonez ce dépôt
Assurez-vous de cloner les sous-modules (git submodule init + git submodule update)
Installez les dépendances Homebrew avec brew bundle
Vous devrez utiliser Xcode 14.x pour l'instant
Configurez la signature de code pour toutes les cibles avec un compte développeur Apple payant (requis en raison des droits VPN) et modifiez les identifiants de bundle pour qu'ils soient uniques
Nettoyez le dossier de build dans Xcode (Cmd+Shift+K)

Constantes obfusquées

Un ensemble de secrets est requis pour construire le projet. Ils comprennent des URL et des clés, et sont conservés dans des fichiers nommés ObfuscatedConstants.swift. Ces fichiers sont conservés dans un dépôt séparé, ce qui nécessite une configuration supplémentaire pour rester synchronisé.

Tout d'abord, appelez le script situé dans Integration/Scripts/credentials.sh avec la commande setup. Fournissez le chemin où vous souhaitez que le dépôt des secrets soit cloné localement à l'aide de l'argument -p, et l'URL du dépôt à l'aide de l'argument -r.

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

Ensuite, pour vérifier que la configuration a réussi :

./Integration/Scripts/credentials.sh checkout

Si la configuration est correcte, les constantes obfusquées seront automatiquement synchronisées pendant la phase de construction « Generate Obfuscated Constants » de chaque application.

Structure des paquets

Le projet est organisé par couches afin d'éviter l'enfer des dépendances de modules :

Foundations : des bibliothèques petites et à usage unique pour construire des choses plus grandes. Elles ne devraient se lier qu'entre elles, si tant est qu'elles se lient.
Shared : des bibliothèques légèrement plus grandes destinées à partager du code entre applications ou extensions. Les parties de cette bibliothèque qui deviennent trop grandes ou qui gagneraient à être leur propre module peuvent être extraites dans Foundations. Ces bibliothèques ne devraient se lier qu'aux bibliothèques de Foundations, à l'exception possible de chacune de ces bibliothèques qui se lie à CoreCommon.
Features : des bibliothèques autonomes contenant une fonctionnalité unique. Ces bibliothèques ne devraient se lier qu'aux bibliothèques des catégories Shared ou Foundations. Elles sont incluses et instanciées dans le code des applications, des tests ou des extensions.

L'ajout de nouveau code/fonctionnalité à LegacyCommon et NEHelper devrait être évité si possible. Ces paquets devraient être progressivement réduits afin de placer leurs composants dans des paquets nouveaux/existants des trois catégories ci-dessus.

Linting du code

Pendant le développement, swiftlint est exécuté en mode non strict pour qu'il soit plus facile de développer sans se soucier du formatage du code. Sur la CI, le linting est strict et échouera au moindre avertissement. Avant de committer du code dans ce dépôt, exécutez le script suivant pour ajouter un hook de pre-commit qui vérifiera tous les fichiers nouveaux/modifiés en mode strict et vous empêchera de committer du code qui ne passerait pas la CI.

./Integration/Scripts/pre_commit_lint.sh setup

Localisation

L'application utilise SwiftGen pour générer le fichier Localizable.strings afin d'accéder à toutes les chaînes de l'application stockées dans les fichiers Localizable.strings standard. Ajoutez simplement une nouvelle chaîne au paquet Strings et exécutez la commande swiftgen dans un répertoire où swiftgen.yml est défini.

Licence

Le code et les fichiers de données de cette distribution sont sous licence selon les termes de la GPLv3 telle que publiée par la Free Software Foundation. Voir https://www.gnu.org/licenses/ pour une copie de cette licence.

ios-mac-app

Populaires