Proton VPN for iOS and macOS

Copyright (c) 2025 Proton Technologies AG

依存関係

このプロジェクトは、すべての依存関係に Swift Package Manager を使用しています。ターゲットを実行する前に、Xcode でパッケージを解決できるようにしてください。

サードパーティの依存関係

ACKNOWLEDGEMENTS.md

セットアップ

• お使いのマシンで Git LFS を有効にしてください
• このリポジトリをクローンしてください
• サブモジュールもクローンしてください (git submodule init + git submodule update)
• brew bundle を使用して Homebrew の依存関係をインストールしてください
• 現在は Xcode 14.x を使用する必要があります
• 有料の Apple 開発者アカウントを使用して、すべてのターゲットのコード署名を設定し (VPN エンタイトルメントが必要なため)、バンドル識別子を一意なものに変更してください
• Xcode でビルドフォルダをクリーンアップしてください (Cmd+Shift+K)

難読化された定数

プロジェクトをビルドするには、一連のシークレットが必要です。これらには URL とキーが含まれており、ObfuscatedConstants.swift という名前のファイルに保管されています。これらのファイルは別のリポジトリに保管されているため、同期を維持するには追加のセットアップが必要です。

まず、Integration/Scripts/credentials.sh にあるスクリプトを setup コマンドで実行してください。-p 引数にはシークレットリポジトリをローカルにクローンしたいパスを指定し、-r 引数にはリポジトリの URL を指定します。

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

次に、セットアップが成功したことを確認するには:

./Integration/Scripts/credentials.sh checkout

セットアップが正しく行われていれば、難読化された定数は各アプリの Generate Obfuscated Constants ビルドフェーズ中に自動的に同期されます。

パッケージ構成

このプロジェクトは、モジュール依存関係の地獄を避けるために、レイヤーごとにパッケージ化されています:

• Foundations: より大きなものを構築するための、小さく単一目的のライブラリ群です。これらは、仮にリンクするとしても、常に相互にのみリンクするべきです。
• Shared: アプリケーションや拡張機能間でコードを共有するための、やや大きめのライブラリ群です。大きくなりすぎたり、独立したモジュールにした方がよい部分は、Foundations に分割できます。これらは、それぞれが CoreCommon にリンクするという例外を除いて、Foundations ライブラリとのみリンクするべきです。
• Features: 単一の機能を含む自己完結型のライブラリ群です。これらのライブラリは、Shared または Foundations カテゴリのライブラリとのみリンクするべきです。これらは、アプリケーション、テスト、または拡張機能のコード内に含まれ、インスタンス化されます。

可能であれば、LegacyCommon と NEHelper に新しいコードや機能を追加することは避けるべきです。これらのパッケージは、そのコンポーネントを上記の3つのカテゴリの新規/既存パッケージに配置するために、段階的に削減していくべきです。

コードのリンティング

開発中は swiftlint が非厳格モードで実行されるため、コードの書式を気にせずに開発しやすくなっています。CI ではリンティングは厳格で、警告があれば失敗します。このリポジトリにコードをコミットする前に、以下のスクリプトを実行してプリコミットフックを追加してください。このフックは、新規/変更されたすべてのファイルを厳格モードでチェックし、CI を通過できないコードのコミットを防ぎます。

./Integration/Scripts/pre_commit_lint.sh setup

ローカライゼーション

このアプリは SwiftGen を使用して、標準の Localizable.strings ファイルに保存されているすべてのアプリ文字列にアクセスするための Localizable.strings ファイルを生成します。Strings パッケージに新しい文字列を追加し、swiftgen.yml が定義されているディレクトリで swiftgen コマンドを実行するだけです。

ライセンス

この配布物に含まれるコードおよびデータファイルは、フリーソフトウェア財団が公開する GPLv3 の条件に基づいてライセンスされています。このライセンスのコピーについては、https://www.gnu.org/licenses/ を参照してください。

Copyright (c) 2025 Proton Technologies AG