Package Manager Product Definitions

SwiftPM にプロダクト（product） という概念を正式に導入します。パッケージが外部に公開する出力をマニフェストで明示的に宣言できるようにし、さらに他パッケージのプロダクト単位で依存を張れるようにします。

プロダクトを宣言する

Package() イニシャライザに products パラメータが追加されます。プロダクトは「型（実行ファイル / ライブラリ）」「一意な名前」「実装となる root ターゲットのリスト」から成り、ライブラリであれば静的か動的かといった追加属性も指定できます。

let package = Package(
    name: "MyServer",
    targets: [
        Target(name: "Utils"),
        Target(name: "HTTP", dependencies: ["Utils"]),
        Target(name: "ClientAPI", dependencies: ["HTTP", "Utils"]),
        Target(name: "ServerAPI", dependencies: ["HTTP"]),
        Target(name: "ServerDaemon", dependencies: ["ServerAPI"]),
    ],
    products: [
        .Library(name: "ClientLib", type: .static, targets: ["ClientAPI"]),
        .Library(name: "ServerLib", type: .dynamic, targets: ["ServerAPI"]),
        .Executable(name: "myserver", targets: ["ServerDaemon"]),
    ]
)

プロダクトに列挙する targets は root ターゲット であり、クライアントに見せるインターフェースを持つモジュールを指します。そのターゲットが依存している他ターゲット（上の例なら HTTP や Utils）も一緒にコンパイル・リンクはされますが、クライアントからはインターフェースが見えないことを意図しています（現状の Swift コンパイラにはこのモジュール可視性制御が無いため、あくまで作者の意図表明ですが、将来的なコンパイラ対応が期待されています）。

ライブラリは .static / .dynamic を明示できますが、可能な限り省略することが推奨されます。省略すればビルドシステムがプラットフォームに適したデフォルトを選びます。

同じターゲットを複数のプロダクトに含めることもできます。ただし、すべてのターゲットがすべてのプロダクトで使えるわけではありません（たとえばテストターゲットはライブラリプロダクトに含められません）。テストはプロダクトとして扱われず、宣言する必要もありません。

初期はプロダクトの型として 実行ファイル（Executable） と ライブラリ（Library） が用意されます。Product は以下のようにネストされた型として定義されます。

public enum Product {
    public class Executable {
        public init(name: String, targets: [String])
    }

    public class Library {
        public enum LibType {
            case .static
            case .dynamic
        }
        public init(name: String, type: LibType? = nil, targets: [String])
    }
}

プロダクト単位の依存

ターゲットの依存宣言を拡張し、他パッケージのプロダクトに依存を張れるようになります。Target の dependencies は従来同パッケージ内のターゲットを指す文字列を並べるものでしたが、そこに .product(name:package:) を書けるようになります。

let package = Package(
    name: "MyClientLib",
    dependencies: [
        .package(url: "https://github.com/Alamofire/Alamofire", majorVersion: 3),
    ],
    targets: [
        Target(name: "MyUtils"),
        Target(name: "MyClientLib", dependencies: [
            .target(name: "MyUtils"),
            .product(name: "Alamofire", package: "Alamofire")
        ])
    ]
)

package 引数は省略可能です。プロダクト名が一意であれば書かなくてよく、同名プロダクトが複数の依存パッケージに存在する場合のみ明示が必要です。

従来どおり、依存は文字列ショートハンドでも書けます。その場合、SwiftPM はまず同一パッケージ内のターゲット名として解決を試み、見つからなければ依存パッケージのプロダクト名として解決します。内部では TargetDependency に新たに ByName ケースが追加され、パッケージグラフ解決時にターゲット/プロダクトのいずれかへ束縛されます。

// 次の 2 つは等価
Target(name: "Foo", dependencies: ["Bar", "Baz"])
Target(name: "Foo", dependencies: [.target(name: "Bar"), .target(name: "Baz")])

なお、参照できるプロダクトは直接の依存パッケージのもののみです。間接依存のプロダクトは見えません。

暗黙プロダクトと後方互換性

既存パッケージへの影響を最小化するため、暗黙プロダクトの推定ルールは残されます。

• PackageDescription API の バージョン 3 を使っているパッケージでは、products を省略すると従来どおりの推定ルールが適用されます（実行モジュールごとに実行ファイルプロダクト、ライブラリターゲットがあればパッケージ名のライブラリプロダクトをひとつ）。また、直接依存している他パッケージに対しては暗黙の依存が張られます。
• PackageDescription API の バージョン 4 に移行すると、プロダクトおよびプロダクト依存の宣言は作者の責任になります。swift package init は新規パッケージ作成時に適切なプロダクト定義を自動で追加し、既存パッケージの移行時には「このパッケージはプロダクトを定義していません」という警告と fix-it による補助が提供されます。

swift package describe は暗黙的に推定されたプロダクトも表示するので、移行時の確認に役立ちます。

この変更がもたらす実利

プロダクトの導入により、ひとつのパッケージ内で「公開ライブラリ」「コマンドラインツール」「内部共有実装」といった概念的に別物の出力を、それぞれ独立した依存先として宣言できるようになります。これまでのようにパッケージを無理に分割する必要がなくなり、単一のバージョン番号のもとで一貫した管理が可能になります。また、ライブラリの静的/動的の別を作者自身が制御できるようになり、将来新しいプロダクトの種類が追加されたときも同じ枠組みで拡張できます。