Tuist v3からv4へ

Tuist 4](https://github.com/tuist/tuist/releases/tag/4.0.0)のリリースに伴い、私たちはプロジェクトにいくつかの変更点を導入する機会を得ました。この文書では、Tuist 3からTuist 4にアップグレードするためにプロジェクトに加える必要のある変更について概説します。

tuistenv {#dropped-version-management-through-tuistenv} によるバージョン管理の廃止。

Tuist 4以前では、インストールスクリプトはtuistenv というツールをインストールし、インストール時にtuist という名前に変更された。このツールはTuistのバージョンのインストールとアクティベーションを担当し、環境間の決定性を保証する。Tuistのフィーチャー・サーフェスを減らす目的で、私たちはtuistenv をやめ、Miseを採用することにしました。これは同じ仕事をするツールですが、より柔軟で、異なるツール間で使用することができます。tuistenv を使用していた場合、curl -Ls https://uninstall.tuist.io | bash を実行して現在のバージョンのTuistをアンインストールし、その後お好みのインストール方法でインストールする必要があります。Miseの利用を強くお勧めします。なぜならMiseは環境間で決定論的にインストールとアクティベーションができるからです。

Uninstall tuistenv

curl -Ls https://uninstall.tuist.io | bash

CI 環境と XCODE プロジェクトにおけるミスの警告

Miseがもたらす決定論を全面的に受け入れることを決めた場合、CI環境とXcodeプロジェクトでMiseを使用する方法のドキュメントをチェックすることをお勧めします。

:::

::: 情報 HOMEBREWはサポートされています。

macOS用の一般的なパッケージマネージャであるHomebrewを使用してもTuistをインストールできることに注意してほしい。Homebrewを使ってTuistをインストールする方法はインストールガイドにあります。

:::

Droppedinit constructors fromProjectDescription models {#dropped-init-constructors-from-projectdescription-models}.

APIの可読性と表現力を向上させる目的で、ProjectDescription のすべてのモデルからinit コンストラクタを削除することにしました。すべてのモデルは、モデルのインスタンスを生成するために使うことができる静的なコンストラクタを提供するようになりました。init コンストラクタを使用していた場合は、代わりに静的コンストラクタを使用するようにプロジェクトを更新する必要があります。

ネーミング・コンベンション

静的コンストラクタの名前としてモデル名を使用するのが、私たちが従う命名規則です。例えば、Target モデルの静的コンストラクタはTarget.target です。

:::

--no-cache を--no-binary-cache {#renamed-nocache-to-nobinarycache} にリネーム。

--no-cache フラグがあいまいだったので、バイナリ・キャッシュを指すことを明確にするために、--no-binary-cache に名前を変更することにしました。--no-cache フラグを使用していた場合は、代わりに--no-binary-cache フラグを使用するようにプロジェクトを更新する必要があります。

tuist fetch をtuist install {#renamed-tuist-fetch-to-tuist-install} にリネーム。

業界の慣例に合わせるため、tuist fetch コマンドの名前をtuist install に変更しました。tuist fetch コマンドを使っていた場合は、代わりにtuist install コマンドを使うようにプロジェクトを更新する必要があります。

Package.swift を依存関係の DSL として採用。

Tuist 4以前は、Dependencies.swift ファイルで依存関係を定義できました。この独自形式は、DependabotやRenovatebotのようなツールで依存関係を自動的に更新するサポートを壊していた。さらに、ユーザーにとって不必要な間接参照を導入していました。そこで、Package.swift をTuistで依存関係を定義する唯一の方法として採用することにしました。Dependencies.swift ファイルを使用していた場合、Tuist/Dependencies.swift の内容をルートにあるPackage.swift に移動し、#if TUIST ディレクティブを使用して統合を設定する必要があります。Swiftパッケージの依存関係を統合する方法についてはこちらをご覧ください。

tuist cache warm をtuist cache {#renamed-tuist-cache-warm-to-tuist-cache} にリネーム。

簡潔にするため、tuist cache warm コマンドの名前を、tuist cache に変更することにしました。tuist cache warm コマンドを使っていた場合は、代わりにtuist cache コマンドを使うようにプロジェクトを更新する必要があります。

tuist cache print-hashes をtuist cache --print-hashes {#renamed-tuist-cache-printhashes-to-tuist-cache-printhashes} に変更。

私たちは、tuist cache print-hashes コマンドの名前を、tuist cache --print-hashes に変更し、tuist cache コマンドのフラグであることを明確にすることにしました。tuist cache print-hashes コマンドを使っていた場合は、代わりにtuist cache --print-hashes フラグを使うようにプロジェクトを更新する必要があります。

キャッシング・プロファイルの削除

Tuist 4以前は、Tuist/Config.swift にキャッシュ用の設定を含むキャッシュ・プロファイルを定義できました。この機能を削除することにしたのは、プロジェクトの生成に使用したプロファイル以外のプロファイルを生成プロセスで使用すると混乱につながる可能性があったからです。さらに、ユーザーがアプリのリリースバージョンをビルドするためにデバッグプロファイルを使用することにつながり、予期しない結果につながる可能性があります。その代わりに、--configuration オプションを導入しました。このオプションを使うと、プロジェクトの生成時に使用する設定を指定できます。キャッシング・プロファイルを使用していた場合は、代わりに--configuration オプションを使用するようにプロジェクトを更新する必要があります。

--skip-cache を削除し、引数を優先 {#removed-skipcache-in-favor-of-arguments}.

generate コマンドから--skip-cache フラグを削除し、引数を使用してバイナリキャッシュをスキップするターゲットを制御するようにしました。--skip-cache フラグを使用していた場合は、代わりに引数を使用するようにプロジェクトを更新する必要があります。

Before

tuist generate --skip-cache Foo

After

tuist generate Foo

削除された署名機能。

署名は、FastlaneやXcode自体のようなコミュニティツールによってすでに解決されており、それらの方がはるかに良い仕事をしている。私たちは、署名はTuistのストレッチゴールであり、プロジェクトのコア機能に集中した方が良いと考えました。リポジトリ内の証明書とプロファイルを暗号化し、生成時に適切な場所にインストールすることで構成されるTuistの署名機能を使用していた場合、プロジェクト生成前に実行する独自のスクリプトでそのロジックを複製したいと思うかもしれません。特に

• ファイルシステムまたは環境変数に格納されているキーを使用して証明書とプロ ファイルを復号化し、証明書をキーチェーンに、プロビジョニング・プロファイルをディレク トリ~/Library/MobileDevice/Provisioning Profiles にインストールするスクリプト。
• 既存のプロファイルと証明書を取り込んで暗号化するスクリプト。

署名の必要条件

署名には、正しい証明書がキーチェーンに存在し、プロビジョニング・プロファイルが~/Library/MobileDevice/Provisioning Profiles ディレクトリに存在する必要がある。キーチェーンに証明書をインストールするにはsecurity コマンドラインツールを使用し、プロビジョニング・プロファイルを正しいディレクトリにコピーするにはcp コマンドを使用する。

:::

Dependencies.swift {#dropped-carthage-integration-via-dependenciesswift} によるカルタゴ統合を削除した。

Tuist 4以前は、Carthageの依存関係はDependencies.swift ファイルで定義することができ、ユーザーはtuist fetch を実行することでそれを取得することができました。私たちはまた、Swiftパッケージマネージャが依存関係を管理するための望ましい方法である将来を考慮し、これはTuistのためのストレッチゴールであると感じました。Carthage 依存関係を使用していた場合、Carthage を直接使用して、コンパイル済みのフレームワークと XCFrameworks を Carthage の標準ディレクトリにプルし、TargetDependency.xcframework とTargetDependency.framework のケースを使用してタグセットからこれらのバイナリを参照する必要があります。

::: 情報 カルチェージはまだ支持されている

一部のユーザーは、我々がカルタゴのサポートをやめたと理解していた。そうではありません。TuistとCarthageの出力の間の契約は、システムに格納されたフレームワークとXCFrameworksに対するものです。唯一変わったのは、誰が依存関係のフェッチに責任を持つかということです。以前はCarthageを通してTuistでしたが、今はCarthageです。

:::

TargetDependency.packagePlugin API {#dropped-the-targetdependencypackageplugin-api} を削除しました。

Tuist 4以前は、TargetDependency.packagePlugin caseを使用してパッケージプラグイン依存関係を定義することができました。Swiftパッケージマネージャが新しいパッケージタイプを導入するのを見た後、私たちはより柔軟で将来性のあるものに向けてAPIを反復することにしました。TargetDependency.packagePlugin を使用していた場合、代わりにTargetDependency.package を使用し、引数として使用したいパッケージのタイプを渡す必要があります。

廃止された非推奨API。

Tuist 3で非推奨とされたAPIを削除しました。非推奨APIのいずれかを使用していた場合は、新しいAPIを使用するようにプロジェクトを更新する必要があります。