[SwiftPM] SwiftPackage にサンプルプロジェクトを追加する

⌛️ 2 min.

SwiftPackage にサンプルプロジェクトを含める手順を考えてみました。

Sponsor Link

環境＆対象

以下の環境で動作確認を行なっています。

macOS Monterey 12.4 beta2
Xcode 13.3.1
iOS 15.4

サンプルプロジェクトの扱い

SwiftPackage を公開したとき、ドキュメントやサンプルコードが用意されていると、実際に使ってもらう時のハードルが下がります。

ドキュメントやサンプルコードの他に、実際にすぐに動作させることができるプロジェクトがあると、動かしながら動作を確認することができますので、より分かりやすくなります。

ということで、example.xcodeproj のようなプロジェクトを SwiftPackage のそばに置いておくと便利な気がします。

ですが、サンプルプロジェクトを SwiftPackage に含めようとすると、手が止まります。

SwiftPackage は、Package.swift を使って管理されていますが、この Package.swift にサンプルプロジェクトを追加する方法がありません・・・

Package.swift は、.xcodeproj を理解しません

Swift Package は、Package.swift をダブルクリックすることで Xcode でも開けますが、.xcodeproj(Xcodeの通常のプロジェクト情報を持つファイル) があっても使ってくれません。

そもそも、Package.swift にサンプルプロジェクトの情報を記述しても、サンプルプロジェクトはあくまでリファレンス的なものですので、あくまで補足的なものです。

つまり、サンプルプロジェクトを Package.swift に記述する方法はないようです。

別リポジトリにする手もあります

サンプルプロジェクトを用意する１つの方法は、SwiftPackage とは別のリポジトリを作成し、そのリポジトリへのリンク等を Readme に記載しておくことです。（実際に、このような形で公開されているリポジトリも多くあります。）

この方法も良いのですが、次に紹介する方法で１つのリポジトリで管理することもできます。

サブフォルダの中に .xcodeproj

SwiftPackage は、Package.swift に記述された対象しか理解しません。つまり、サブフォルダを作成して、何かを配置しておいてもエラーという扱いになりません。

このことを利用して、サブフォルダにサンプルプロジェクトを置いておくことができます。

１つのリポジトリに置いておくことで、メンテナンスのときの手間を少しですが、減らすこともできると思います。

サブフォルダであることは必要？

（試していませんが）.xcodeproj ファイルを Package.swift と同じ場所に配置することも可能だと思います。ですが、２つのフォルダ構成が１つのフォルダを共有する形になってしまうので、不必要に複雑化してしまい、お勧めしません。

Swift Package に example project を追加する

実際に、Swift Package にサンプルプロジェクトを追加していってみます。

SDSCustomView というすでに存在する SwiftPackage に、サンプルプロジェクトを追加してみます。
追加前のフォルダは以下のようになっています。

projectを作る

Xcode 上で、「File」 -「New」-「Project…」を使って、サンプルプロジェクトを作成します。

プロジェクトの保存場所に SwiftPackage の Package.swift があるフォルダを選択してください。

このときに、作成するプロジェクトでは、git を有効にしないでください。（有効できなくなっているはずです）

注意

git 操作を行うときは、コマンドラインであれば、Package.swift の存在するフォルダから。
Xcode であれば、Package.swift で開いた状態で git 操作を行なってください。
あくまで git のルートディレクトリは、Package.swift の存在するディレクトリです。

以下のスクリーンショットは、”FixedWidthLabelExample” というプロジェクトを作成した状態です。