ディレクトリ構造

Tuistプロジェクトは一般的にXcodeプロジェクトを置き換えるために使われますが、この用途に限定されるものではありません。Tuistプロジェクトは、SPMパッケージ、テンプレート、プラグイン、タスクなど、他の種類のプロジェクトを生成するためにも使用されます。このドキュメントでは、Tuistプロジェクトの構造とその整理方法について説明します。後のセクションでは、テンプレート、プラグイン、タスクの定義方法についても扱います。

標準的なTuistプロジェクト#

TuistプロジェクトはTuistによって生成される最も一般的なプロジェクトタイプです。 アプリ、フレームワーク、ライブラリなどの構築に使用されます。Xcodeプロジェクトとは異なり、TuistプロジェクトはSwiftで定義されるため、より柔軟で保守が容易です。また、宣言的であるため、理解しやすく、推論もしやすくなります。以下の構造は、Xcodeプロジェクトを生成する典型的なTuistプロジェクトを示しています。

• Tuistディレクトリ: このディレクトリには2つの目的があります。第一に、プロジェクトのルートがどこにあるかを示します。これにより、プロジェクトのルートからの相対パスを構築したり、プロジェクト内の任意のディレクトリからTuistコマンドを実行したりできます。第二に、以下のファイルのコンテナとなります。

  • ProjectDescriptionHelpers: このディレクトリには、すべてのマニフェストファイルで共有されるSwiftコードが含まれています。マニフェストファイルはこのディレクトリで定義されたコードを使用するためにimport ProjectDescriptionHelpersできます。コードを共有することは、重複を避け、プロジェクト間の一貫性を確保するのに役立ちます。
  • Package.swift: このファイルには、TuistがXcodeプロジェクトとターゲットを使用して統合するためのSwift Package依存関係が含まれており、設定および最適化が可能です（CocoaPodsのようなもの）。詳細はこちらをご覧ください。

• ルートディレクトリ: プロジェクトのルートディレクトリであり、Tuistディレクトリも含まれています。

  • Tuist.swift: このファイルには、すべてのプロジェクト、ワークスペース、環境で共有されるTuistの設定が含まれています。例えば、スキームの自動生成を無効にしたり、プロジェクトのデプロイメントターゲットを定義したりするために使用できます。
  • Workspace.swift: このマニフェストはXcodeワークスペースを表します。他のプロジェクトをグループ化するために使用され、追加のファイルやスキームを追加することもできます。
  • Project.swift: このマニフェストはXcodeプロジェクトを表します。プロジェクトの一部であるターゲットとその依存関係を定義するために使用されます。

上記のプロジェクトを操作する場合、コマンドは作業ディレクトリまたは--pathフラグで指定されたディレクトリ内にWorkspace.swiftまたはProject.swiftファイルがあることを期待します。マニフェストは、プロジェクトのルートを表すTuistディレクトリを含むディレクトリ、またはそのサブディレクトリにある必要があります。

Swift Package #

TuistはSPMパッケージプロジェクトもサポートしています。SPMパッケージで作業している場合、何も更新する必要はありません。Tuistは自動的にルートのPackage.swiftを検出し、Tuistのすべての機能はそれがProject.swiftマニフェストであるかのように動作します。

開始するには、SPM パッケージで tuist install と tuist generate を実行します。プロジェクトには、通常の Xcode SPM 統合で表示されるのと同じすべてのスキームとファイルが揃っているはずです。さらに、tuist cache を実行して SPM の依存関係とモジュールの大部分を事前コンパイルできるため、後続のビルドが非常に高速になります。