【ITニュース解説】Getting Started with Tuist: Manage iOS Projects with ease

Tuistは、iOSアプリ開発において、Xcodeプロジェクトの管理を大幅に効率化するためのコマンドラインツールである。一般的なパッケージマネージャー、例えばCocoaPodsやSwift Package Managerがアプリが利用する外部のライブラリやフレームワーク（依存関係）を管理するのに対し、Tuistはそれらとは異なり、開発者が日々向き合うXcodeプロジェクトファイルそのものの構成や設定を管理することに特化している。

具体的に言うと、TuistはXcodeプロジェクトを構成する .xcodeproj ファイルというものを、直接手作業で編集するのではなく、シンプルなSwiftコードでその構造を定義できるようにする。この方法は「Infrastructure as Code（インフラをコードで管理する）」という考え方に似ており、iOSプロジェクトにおける設定をコードで記述し、バージョン管理するイメージに近い。開発者がこのSwiftファイル（一般的に Project.swift と呼ばれる）にプロジェクトの構成を記述すると、Tuistはその記述に基づいて自動で .xcodeproj ファイルを生成してくれるのだ。

では、なぜTuistのようなツールが必要なのだろうか。その最大の理由の一つは、従来のXcodeプロジェクト管理における「マージコンフリクト」の解消である。.xcodeproj ファイルはXMLベースの複雑な構造をしており、複数の開発者が同時に変更を加えると、Gitなどのバージョン管理システムで変更を統合（マージ）する際に、しばしば衝突（コンフリクト）が発生し、その解決が非常に困難だった。このコンフリクト解決は時間と労力を要し、開発の生産性を著しく低下させる要因となっていた。Tuistでは、プロジェクトの設定を人間にとって読み書きしやすいSwiftコードで記述するため、変更内容のレビューが容易になり、万が一マージコンフリクトが発生しても、テキストベースのコードとして解決しやすくなる。

次に重要なメリットは、チーム内での「一貫性」の確保である。Tuistを使用すると、チームの全員が同じ Project.swift ファイルから同じ構造のXcodeプロジェクトを生成する。これにより、個々の開発者の環境や設定の違いに起因するビルドエラーや動作の不整合を防ぎ、全員が同じスタートラインで開発を進めることができる。

また、Tuistは「モジュール化」を容易にする。大規模なアプリケーションでは、コードを機能ごとに小さなまとまり（モジュールやフレームワーク）に分割することが推奨される。これは、コードの再利用性を高め、開発を並行して進めやすくし、ビルド時間を短縮する効果がある。Tuistを使えば、これらのモジュールをXcodeプロジェクト内で管理し、相互の依存関係を設定することが、手作業に比べて格段に簡単になる。これにより、プロジェクトが成長しても、コードベースを整理された状態に保ちやすくなるのだ。

「ビルド時間の最適化」も、Tuistの大きな特徴である。Tuistは、コンパイル済みのフレームワークなどをキャッシュし、それをチームメンバー間で共有する機能を持っている。これにより、一から全てのコードをコンパイルし直す必要がなくなり、特に大規模プロジェクトでのビルド時間を大幅に短縮できる。これは開発者の待ち時間を減らし、生産性向上に直結する。

さらに、「Git履歴のクリーンさ」も実現する。.xcodeproj ファイルや .xcworkspace ファイルといった、Tuistによって自動生成されるファイルは、Gitのバージョン管理から除外（.gitignore に追加）することができる。バージョン管理するのは、プロジェクト設定を記述した Project.swift のような「マニフェストファイル」のみとなるため、Gitの履歴が不要なファイルで膨らむことがなく、本当に重要な設定の変更履歴だけを追うことができる。

これらのメリットから、Tuistは中規模から大規模なiOSプロジェクト、チーム開発でマージコンフリクトに悩まされているプロジェクト、アプリのモジュール化を進めたい場合、あるいは新しいプロジェクトを最初から最適な形で始めたい場合に特に適している。

実際にTuistを使い始めるのは非常に簡単である。MacのパッケージマネージャーであるHomebrewが導入されていれば、brew install tuist というシンプルなコマンド一つでインストールが完了する。または、公式のインストーラーを使った方法でもインストールできる。インストール後、tuist --version コマンドを実行してバージョン情報が表示されれば、準備は完了だ。

それでは、実際に簡単なiOSアプリをTuistで作成してみよう。ここではMVVM（Model-View-ViewModel）というアーキテクチャパターンを採用したシンプルなアプリを想定する。

まず、アプリのプロジェクトを格納する新しいディレクトリ（例：MyTuistApp）を作成し、そのディレクトリに移動する。 次に、tuist init コマンドを実行してTuistプロジェクトを初期化する。この際、Tuistはいくつか質問をしてくる。アプリの名前（例：MyApp）、ターゲットプラットフォーム（iOSを選択）、そしてサーバーの利用について尋ねられるので、ここではサーバーは使わないと答える。このコマンドが完了すると、Project.swiftというプロジェクト設定ファイルと、Tuistの設定を格納するTuist/フォルダ、そして基本的なフォルダ構造が自動的に生成される。生成されたMyAppディレクトリに移動しよう。

次に、アプリのコードを整理するためのフォルダ構造を作成する。MVVMアーキテクチャに沿って、Sources/App、Sources/Models、Sources/ViewModels、Sources/Viewsといったディレクトリを作成し、さらにリソース用のResources/Assets.xcassetsとテスト用のTests/ディレクトリも用意する。

これらのフォルダ構造を反映するように、Project.swiftファイルを編集する。このファイルはSwiftコードで書かれており、Xcodeプロジェクトの構造を宣言的に定義する。具体的には、アプリのターゲット（例：MyApp）とテストターゲット（例：MyAppTests）の二つを定義する。アプリターゲットには、どのiOSデバイス向けか（destinations: .iOS）、生成される成果物の種類はアプリであること（product: .app）、バンドルID（bundleId）、アプリの表示に関する情報（infoPlist）、そしてアプリのソースコードがどこにあるか（sources: ["Sources/**"]）やリソースファイルがどこにあるか（resources: ["Resources/**"]）を指定する。テストターゲットに関しても同様に、ソースコードの場所や、どのターゲット（ここではMyApp）に依存しているかなどを記述する。

Project.swiftの編集が完了したら、実際にアプリのソースコードを作成していく。まず、アプリのエントリーポイントとなるSources/App/MyAppApp.swiftファイルを作成し、@main属性を持つApp構造体を定義して、アプリの起動時に表示されるルートビュー（ContentView）を指定する。 次に、Sources/Models/User.swiftファイルに簡単なデータ構造を定義する。これはIdentifiableプロトコルに準拠したUser構造体で、IDと名前を持つ。 Sources/ViewModels/ContentViewModel.swiftファイルには、ObservableObjectプロトコルに準拠したContentViewModelクラスを作成し、@Publishedプロパティとしてgreetingという文字列を定義する。これがビューに表示されるデータとなる。 最後に、Sources/Views/ContentView.swiftファイルにアプリのユーザーインターフェースを定義する。ContentView構造体では、先ほど作成したContentViewModelを@StateObjectとしてインスタンス化し、そのgreetingプロパティの値をTextビューに表示するシンプルな構成とする。

全てのファイル作成と編集が完了したら、いよいよTuistの魔法を体験する番だ。プロジェクトのルートディレクトリで tuist generate コマンドを実行する。このコマンドを実行すると、Tuistは Project.swift の内容を読み込み、それに基づいて MyApp.xcodeproj というXcodeプロジェクトファイルを自動的に生成し、さらにそのXcodeプロジェクトを自動でXcodeで開いてくれる。Xcodeが開いたら、⌘ + R キーを押してアプリをビルドし、実行してみよう。シミュレーター上で「Hello from Tuist!」というメッセージが表示されれば成功だ。

このようにして作成されたプロジェクトの最終的な構造は、MyApp/ディレクトリの中に、Project.swift、Tuist/（設定ファイル）、そしてSources/、Resources/、Tests/といった、コードやリソースを格納する整理されたディレクトリ群がある形となる。

Tuistには他にも便利なコマンドが用意されている。例えば、tuist initで新規プロジェクトを初期化し、tuist generateでXcodeプロジェクトを生成する以外にも、tuist cleanで生成された一時ファイルを削除したり、tuist editで Project.swift などのマニフェストファイルをXcodeで編集するための専用プロジェクトを開いたり、tuist graphでプロジェクト内の依存関係を視覚化したりできる。困った時には tuist --help で利用可能なコマンドの一覧や使い方のヒントを確認できる。

Tuistを導入する前と後では、プロジェクト管理の方法が劇的に変わる。Tuist導入前は、手動でのXcodeプロジェクト設定、頻繁な.xcodeprojでのマージコンフリクト、チーム内での設定の不整合、そしてコードのリファクタリングやモジュール化の難しさといった課題があった。しかし、Tuist導入後は、プロジェクト設定がSwiftコードで定義され、変更点のコードレビューが容易になり、一貫したプロジェクト生成が実現し、モジュール化やスケーリングがシンプルになる。

Gitでバージョン管理を行う際には、Tuistが生成する .xcodeproj、.xcworkspace、そしてビルドの中間生成物である Derived/ フォルダを .gitignore ファイルに追加することを忘れてはならない。これにより、Gitの履歴からこれらの自動生成ファイルを除外できる。ただし、Tuistの動作に必要な Tuist/ ディレクトリ内のファイルはバージョン管理に含める必要があるため、.gitignoreに !Tuist/ と追記して除外対象から外すことを推奨する。

結論として、TuistはXcodeプロジェクトをコードとして定義することで、開発チームに一貫性、コンフリクトの削減、そしてプロジェクトのスケーリングの容易さをもたらす強力なツールである。新規プロジェクトを立ち上げる際にも、既存のプロジェクトの管理を改善したい場合にも、Tuistはアプリケーションの成長に伴う複雑さを効率的に管理するための有効な手段となるだろう。