Swift PackageのSchemeの法則

自作Swift PackageのテストをCI上で動かそうとする時、xcodebuildコマンドでSchemeを指定することになります。（swiftコマンドだとdestinationを指定できないため、特定プラットフォームに依存したライブラリの場合はxcodebuildコマンドを使うことになります。）

SchemeはPackage.swiftファイルがあるルートでxcodebuild -listを実行すれば一覧が確認できます。

$ xcodebuild -list
中略

Information about workspace "LicenseList":
    Schemes:
        LicenseList
        LicenseList-Package
        spp

ただ、このScheme名がSwift Packageの作り方によって異なる命名になることがあるなと気づいたため、法則を調査しました。

xcodebuild -listで見つかるSchemes

• productsが空の場合
  • Packageのnameのみ
• productsにlibraryが一つでPackageのnameとlibraryのnameが一致している場合
  • Packageのnameのみ
• productsにlibraryが一つでPackageのnameとlibraryのnameが一致していない場合
  • Packageのnameのみ
• productsにlibraryが二つ以上の場合
  • Packageのnameに-Packageサフィックスがついたものとそれぞれのlibraryのname
• productsにlibraryが一つでtargetsにexecutableTargetが一つの場合
  • Packageのnameに-PackageサフィックスがついたものとlibraryのnameとexecutableTargetのname
• productsが空でtargetsにexecutableTargetが一つで、PackageのnameとexecutableTargetのnameが一致している
  • Packageのnameのみ
• productsが空でtargetsにexecutableTargetが一つで、PackageのnameとexecutableTargetのnameが一致していない
  • Packageのnameのみ

表にすると以下のようになります。

products	executableTarget	Schemes
空	なし	PackageName
library １つ	なし	PackageName
library ２つ	なし	PackageName-Package LibraryName1 LibraryName2
空	あり	PackageName
library １つ	あり	PackageName-Package LibraryName ExecutableName

つまり、法則性をまとめると

• targetはproductsにlibraryとして含めるとScheme１つ分としてカウントされる
• executableTargetはproductsにexecutableとして含めなくてもScheme１つ分としてカウントされる
• Schemeとしてカウントできるものが１つしかない時はPackage名がSchemeになる
• Schemeとしてカウントできるものが２つ以上ある時はPackage名に-Packageサフィックスをつけたものと、それぞれのnameがSchemeになる

ということになりそうです。

これを知識として持っているといいことがあるわけではありませんが、-Packageサフィックスがつくのはどういう時なの？と疑問に思ったことがある人は安心してScheme名を指定できるようになるかもしれません。