遷移 XcodeGen 專案

XcodeGen 是一款專案生成工具，使用 YAML 作為設定格式來定義 Xcode 專案。許多組織採用它是為了避免在使用 Xcode 專案時經常發生的 Git 衝突。 然而，頻繁的 Git 衝突只是組織面臨的眾多問題之一。Xcode 讓開發者面對許多複雜細節與隱含設定，使得在大規模下維護與優化專案變得困難。XcodeGen 在這方面先天不足，因為它是一款生成 Xcode 專案的工具，而非專案管理工具。如果你需要一款能超越單純生成 Xcode 專案、提供更多協助的工具，可以考慮 Tuist。

Swift 勝過 YAML

許多組織也偏好將 Tuist 作為專案生成工具，因為它使用 Swift 作為設定格式。Swift 是開發者熟悉的程式語言，並能提供使用 Xcode 自動完成、型別檢查與驗證功能的便利性。

以下提供一些考量與指引，協助你將專案從 XcodeGen 遷移至 Tuist。

專案生成#

Tuist 與 XcodeGen 都提供 generate 指令，可將你的專案宣告轉換為 Xcode 專案與工作區。

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 必須以其專有的「範本」解決方案 「templates」 來處理。在 Tuist 中，複用能力內建於 Swift 語言本身，並透過名為 project description helpers 的 Swift 模組實現，讓你能在所有 manifest 檔案間重複使用程式碼。

::: 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`#