XcodeGen プロジェクトの移行

XcodeGen は、YAML を設定フォーマットとして使用して Xcode プロジェクトを定義するプロジェクト生成ツールです。多くの組織は、Xcode プロジェクトの作業中に頻繁に発生する Git の競合を回避しようとして、これを採用しました。 しかし、頻繁な Git の競合は、組織が経験する多くの問題の一つにすぎません。Xcode は開発者に多くの複雑さと暗黙的な設定をさらし、大規模なプロジェクトの維持と最適化を困難にします。XcodeGen は Xcode プロジェクトを生成するツールであり、プロジェクトマネージャーではないという設計上、この点で不足しています。Xcode プロジェクトの生成を超えて支援するツールが必要な場合は、Tuist を検討することをお勧めします。

YAML より Swift

多くの組織は、Tuist をプロジェクト生成ツールとしても好んでいます。これは、Swift を設定フォーマットとして使用しているためです。Swift は開発者にとって馴染みのあるプログラミング言語であり、Xcode の自動補完、型チェック、検証機能を使用する利便性を提供します。

以下では、XcodeGen から Tuist へプロジェクトを移行するための考慮事項とガイドラインを紹介します。

プロジェクト生成#

Tuist と XcodeGen の両方は、プロジェクト宣言を Xcode プロジェクトとワークスペースに変換する generate コマンドを提供します。

bash

xcodegen generate

bash

tuist generate

違いは編集体験にあります。Tuist では、tuist edit コマンドを実行でき、これによりその場で Xcode プロジェクトを生成し、開いて作業を開始できます。これは、プロジェクトに迅速な変更を加えたい場合に特に役立ちます。

`project.yaml`#

XcodeGen の project.yaml 記述ファイルは Project.swift になります。さらに、プロジェクトがワークスペース内でどのようにグループ化されるかをカスタマイズする方法として Workspace.swift を使用できます。また、他のプロジェクトのターゲットを参照するターゲットを持つプロジェクト Project.swift を作成することもできます。そのような場合、Tuist はすべてのプロジェクトを含む Xcode ワークスペースを生成します。

bash

/
  project.yaml

bash

/
  Tuist.swift
  Project.swift
  Workspace.swift

Xcode の言語

XcodeGen と Tuist の両方は、Xcode の言語と概念を取り入れています。しかし、Tuist の Swift ベースの設定は、Xcode の自動補完、型チェック、検証機能を使用する利便性を提供します。

仕様テンプレート#

プロジェクト設定の言語としての YAML の欠点の一つは、すぐに使える形で YAML ファイル間での再利用をサポートしていないことです。これはプロジェクトを記述する際の一般的なニーズであり、XcodeGen は独自のプロプライエタリなソリューションである 「テンプレート」 でこれを解決していました。Tuist では、再利用性が言語自体である Swift に組み込まれており、プロジェクト記述ヘルパーという Swift モジュールを通じて、すべてのマニフェストファイル間でコードを再利用できます。

::: code-group

swift

import ProjectDescription

extension Target {
  /**
    This function is a factory of targets that together represent a feature.
  */
  static func featureTargets(name: String) -> [Target] {
    // ...
  }
}

swift

import ProjectDescription
import ProjectDescriptionHelpers // [!code highlight]

let project = Project(name: "MyProject",
                      targets: Target.featureTargets(name: "MyFeature")) // [!code highlight]

XcodeGen プロジェクトの移行

プロジェクト生成#

project.yaml#

仕様テンプレート#

`project.yaml`#