Package Manager Target Based Dependency Resolution

SwiftPM の依存解決を、パッケージグラフで実際に使われているプロダクトに必要な依存だけを解決する方式に変更します。あるパッケージが持つ依存のうち、利用側のパッケージグラフで参照されていないプロダクト（たとえばサンプル実行ファイルやテストターゲットのためだけに宣言された依存）は、クローンも解決も行われません。

これを実現するために、ターゲット依存の宣言にプロダクトを提供するパッケージ名を明示する新しい書き方が導入されます。

.product(name:package:) でパッケージを明示する

ターゲットがほかのパッケージのプロダクトに依存するときは、Target.Dependency の .product(name:package:) を使ってプロダクト名と提供元パッケージ名の両方を指定します。

.target(
    name: "foo",
    dependencies: [.product(name: "bar", package: "bar-package")]
),

package 引数を必須にすることで、SwiftPM はマニフェストを読んだ時点でプロダクトと提供元パッケージの対応関係を確定できます。これにより、依存を実際にクローンする前に「このターゲットをビルドするにはどのパッケージが必要か」を判断でき、使われない依存を解決対象から除外できます。

パッケージ名とプロダクト名が同じような小さなパッケージでは、従来どおり文字列リテラルだけで書く短縮形も引き続き使えます。

.target(
    name: "foo",
    dependencies: ["bar"]
),

この byName 形式は、パッケージ名とプロダクト名が一致する場合の略記として保持されます。

実際の解決の様子

具体例として、前述の irc パッケージと irc-client パッケージを考えます。

// IRC package
let package = Package(
    name: "irc",
    products: [
        .library(name: "irc", targets: ["irc"]),
        .executable(name: "irc-sample", targets: ["irc-sample"]),
    ],
    dependencies: [
       .package(url: "https://github.com/apple/swift-nio.git", from: "1.0.0"),
       .package(url: "https://github.com/swift/ArgParse.git", from: "1.0.0"),
       .package(url: "https://github.com/swift/TestUtilities.git", from: "1.0.0"),
    ],
    targets: [
        .target(
            name: "irc",
            dependencies: [.product(name: "NIO", package: "swift-nio")]
        ),
        .target(
            name: "irc-sample",
            dependencies: ["irc", "ArgParse"]
        ),
        .testTarget(
            name: "ircTests",
            dependencies: [
                "irc",
                .product(name: "Nimble", package: "TestUtilities"),
            ]
        )
    ]
)

// IRC Client package
let package = Package(
    name: "irc-client",
    products: [
        .executable(name: "irc-client", targets: ["irc-client"]),
    ],
    dependencies: [
       .package(url: "https://github.com/swift/irc.git", from: "1.0.0"),
    ],
    targets: [
        .target(name: "irc-client", dependencies: ["irc"]),
    ]
)

irc-client を解決するとき、SwiftPM がクローンするのは irc と swift-nio だけです。ArgParse は irc-sample でしか使われず、Nimble（TestUtilities）は irc のテストターゲットでしか使われないため、どちらも irc-client のビルドには不要と判断され、解決対象から外れます。Package.resolved にもこれらのエントリは現れません。

パッケージ識別子（name 属性）の扱い

当初の実装（Swift 5.2）では、ターゲット依存に書いたパッケージ名と、実際の依存宣言を突き合わせるために、依存宣言側にも name 属性を書く必要がありました。

.package(name: "swift-nio", url: "https://github.com/apple/swift-nio.git", from: "1.0.0")

ただし、この name は依存先パッケージのマニフェストに書かれている name と一致させる必要があり、利用者にとっては「その名前を知るためだけに相手のマニフェストを見に行く」という不便さがありました。

この点を改善するため、5.4 より後のバージョンでは、name を明示しなくても依存 URL の末尾のパスコンポーネント（ローカル依存の場合はパスの末尾）からパッケージ識別子を機械的に決めるように変更されます。たとえば https://github.com/apple/swift-nio.git からは swift-nio という識別子が得られ、.product(name: "NIO", package: "swift-nio") のように書けば済みます。この URL は入力されたままの形で使われ、パーセントエンコーディングやミラー設定の影響は受けません。

併せて、Package.Dependency.package(...) の name: 引数の利用には警告が出るようになり、最終的には非推奨化される予定です（speculative）。

既存パッケージへの影響

この挙動は tools-version で切り替えられるため、古いバージョンの tools-version を宣言しているパッケージには影響しません。古いパッケージは従来どおりすべての依存を解決し、新しい tools-version のパッケージだけが「使われるプロダクトに必要な依存だけを解決する」新方式に従います。ひとつの依存グラフの中に両方のパッケージが混在していても問題ありません。

なお、既に解決済みの依存のあるターゲットに対して後からプロダクト依存を追加すると、それがきっかけで追加の依存解決が走る可能性があります。これは従来の実装でも起こり得たことで、この提案で新しく発生する問題ではありません。

実装状況

この提案は「Partially implemented (Swift 5.2)」というステータスで、マニフェスト API と、使われるプロダクトに関係しないターゲット（テストターゲットなど）をビルド対象から外す部分が先行して実装されています。これにより、依存パッケージのテストターゲットをビルドしないといった効果はすでに得られています。ターゲットベースでの依存解決そのものの完全な実装は、段階的に進められています。