生成されるファイル

Tuist は生成時にファイルやコードを自動生成し、Xcode プロジェクトの管理と作業をより便利にします。このページでは、この機能の概要と、プロジェクトでの活用方法について説明します。

ターゲットリソース#

Xcode プロジェクトでは、ターゲットにリソースを追加できます。ただし、特にモジュラープロジェクトでソースやリソースが頻繁に移動される場合、チームはいくつかの課題に直面します。

• ランタイムアクセスの一貫性の欠如: リソースが最終的な製品内のどこに配置され、どのようにアクセスされるかは、ターゲットの製品タイプに依存します。例えば、ターゲットがアプリケーションを表す場合、リソースはアプリケーションバンドルにコピーされます。これにより、リソースにアクセスするコードがバンドル構造を前提とするようになり、コードの理解が難しくなり、リソースの移動も煩雑になるため、理想的ではありません。
• リソースをサポートしない製品タイプ: 静的ライブラリなど、バンドルではないためリソースをサポートしない製品タイプが存在します。そのため、フレームワークなど別の製品タイプを採用する必要があり、プロジェクトやアプリにオーバーヘッドが生じる可能性があります。例えば、静的フレームワークは最終製品に静的にリンクされ、リソースだけを最終製品にコピーするためのビルドフェーズが必要になります。また、動的フレームワークの場合、Xcode はバイナリとリソースの両方を最終製品にコピーしますが、フレームワークを動的に読み込む必要があるため、アプリの起動時間が増加します。
• ランタイムエラーが発生しやすい: リソースは名前と拡張子（文字列）で識別されます。そのため、これらのいずれかにタイポがあると、リソースへのアクセス時にランタイムエラーが発生します。コンパイル時に検出されず、リリース版でクラッシュを引き起こす可能性があるため、理想的ではありません。

Tuist は、実装の詳細を抽象化したバンドルとリソースにアクセスするための統一されたインターフェースを生成することで、上記の問題を解決します。

リソース#

Tuist は、Info.plist や entitlements などのファイルの内容を Swift で宣言するためのインターフェースを提供します。これは、ターゲットやプロジェクト間の一貫性を確保し、コンパイラを活用してコンパイル時に問題を検出するのに役立ちます。また、独自のアブストラクションを作成して内容をモデル化し、ターゲットやプロジェクト間で共有することも可能です。

プロジェクトが生成されると、Tuist はこれらのファイルの内容を生成し、それらを定義しているプロジェクトを含むディレクトリ相対の Derived ディレクトリに書き込みます。

バンドルアクセサ#

Tuist は、ターゲットリソースを含むバンドルにアクセスするためのインターフェースを生成します。

Swift#

ターゲットには、バンドルを公開する Bundle 型の拡張が含まれます。

Objective-C#

Objective-C では、バンドルにアクセスするための {Target}Resources インターフェースが提供されます。

リソースアクセサ#

リソースは名前と拡張子（文字列）で識別されます。これはコンパイル時に検出されず、リリース版でクラッシュを引き起こす可能性があるため、理想的ではありません。これを防ぐため、Tuist はプロジェクト生成プロセスに SwiftGen を統合し、リソースにアクセスするためのインターフェースを生成します。これにより、コンパイラを活用して問題を確実に検出しながら、安心してリソースにアクセスできます。

Tuist には、以下のリソースタイプに対するアクセサをデフォルトで生成するための テンプレート が含まれています。

注: プロジェクトオプションに disableSynthesizedResourceAccessors オプションを渡すことで、プロジェクト単位でリソースアクセサの生成を無効にできます。

カスタムテンプレート#

SwiftGen でサポートされている他のリソースタイプに対するアクセサを生成するための独自のテンプレートを提供したい場合は、Tuist/ResourceSynthesizers/{name}.stencil に作成できます。ここで、名前はリソースのキャメルケース版です。

生成するアクセサのリソースタイプを構成したい場合は、Project.resourceSynthesizers プロパティを使用して、使用するリソースシンセサイザーのリストを渡します。