Swift Packageプラグインの紹介

Swift Packageプラグインの紹介

Swift Packageプラグインを使用して、SwiftパッケージやXcodeプロジェクトでアクションを実行する方法をご覧ください。このプラグインが機能する仕組みをはじめ、これを使用してソースコードを生成したり開発ワークフローを自動化したりする方法について解説します。

リソース
- - HDビデオ
  - SDビデオ
関連ビデオ

WWDC23
- Swift OpenAPI Generatorの紹介
WWDC22
WWDC19
- SwiftパッケージをXcodeに導入する
ダウンロード

♪ 落ち着いた雰囲気のヒップホップ音楽 ♪ ♪ こんにちは Andersですこのビデオでは Swift package プラグインの使用方法をご紹介します Swift Packages はXcode 11で発売されましたライブラリをソースコードとして配布するためのすばらしい方法を提供します Xcode 14ではこの方法が開発ワークフローに拡張されプラグインを使用してビルド中のソースコードの生成やタスクリリースの自動化などが行えますこのプラグインの内容がどういうものでどう機能するかを説明し Xcode 14でサポートされるコマンドプラグインとビルドツールプラグインの２つのパッケージプラグインをご紹介しますまずプラグインとは何かパッケージプラグインはSwiftスクリプトで SwiftやXcodeでアクションを実行できますプラグインは Xcodeがこの目的のために提供するAPIを使用しますこれはSwift Packageとして実装されますプラグインとライブラリ実行ファイルが含まれるかプラグインだけを含むこともできますパッケージプラグインは複数のソースファイルで実装することができます Swift packageは複数のプラグインを定義できます高度に専門的なプラグインは提供するパッケージ専用にできその場合パッケージ内のみで使用できますしかし一般目的のプラグインはパッケージ製品と定義すれば利用可能にできますパッケージが他のパッケージからのライブラリを使用できるように他のパッケージも使用することができますしかしライブラリとは異なりプラグインでの依存関係は Appにランタイムコンテンツを提供しません代わりに自身のマシンかビルド自動化で実行する開発ツールへのアクセスを許可しますパッケージプラグインはどんな作業をするのでしょう Xcode 14には２種類のプラグインがありますコマンドプラグインとビルドツールプラグインですコマンドプラグインはいつでも実行できるカスタムアクションを実装しますソースコードフォーマッタやリンタで実行できますまたは開発ワークフローの一部として他のタスクを実行できますそれには寄稿者リストの更新や履歴に基づいた著作権の日付の更新または引数スクリプトの作業なども実行できます必要に応じてコマンドプラグインはパッケージのファイルの変更の許可を要求できますコードの編成に特に便利ですすべてのコマンドプラグインに書き込み許可は必要なくコマンドによっては変更の必要がなくレポート作成やメトリクスの計算が行えますビルドツールプラグインは依存性グラフを拡張ビルドの一部としてソースコードやリソースの生成に特に役立ちます一度にパッケージ全体やプロジェクトを呼び出すコマンドプラグインとは異なりビルドツールプラグインは各目標に適用されます Xcodeでコマンドプラグインを使用してみましょうこれはiOS Appでさまざまな幾何学的形状を示すものです Appプロジェクトやローカルパッケージからなりパッケージは Appのコアデータ型とロジックを提供するライブラリを実装します他の人が使用できるようにパッケージを各自のリポジトリに分割しようと思いますその一部としてこのパッケージのコードに寄稿した全員のリストを作成しようと思いますカスタムスクリプトでこれを行えますがコードで作業するのに便利なプラグインを提供するパッケージがあるのを知っていますそれに私が望むプラグインがあるはずですこのプラグインにアクセスするには他のパッケージからライブラリを得るようにローカルパッケージのマニフェストにパッケージの依存関係を追加しますマニフェストを保存すると遠隔パッケージがフェッチされ Package Dependenciesに表示されます SwiftFormatもフェッチされていますコードの編集で人気のツールですユーティリティパッケージのコマンドプラグインが SwiftFormatに依存関係を持ったからですこの依存関係を追加したところでパッケージが提供するプラグインコマンドすべてにアクセスできますコマンドしたいパッケージのコンテキストメニューを使用しますメニューに３つの新しいコマンドがあります SwiftFormatを使用する再編集用ソースコード他の２つでは特別なアクションを実行できます１つは寄稿者リストをGitの寄稿履歴に基づき作成・生成するものでもう１つは私のソースファイルの著作権日付を更新するものですここでは真ん中のコマンドを使用しますプラグインコマンドを呼び出すと Xcodeはプラグインにパスするターゲットを選択させてくれますここではパッケージ全体を呼び出しますプラグインがカスタム引数を取り入れるならそれらもここでパスします「Run」をクリックするとプラグインがファイルシステムを変更するので Xcodeは警告を発しますプラグイン作成者が私のコードを変更したい理由を確認できますがプラグインの実装も見てみたいので「Show Command」を選択しコードに移動します
このプラグインのアクションは安全ですコマンドをもう一度呼び出し次は「Run」を選択します
Xcodeに私が選んだプラグインを覚えてもらいますこの特定のプラグインはGit履歴を使用して寄稿者の名前を含んだファイルリストを生成しますしかし他にもさまざまな機能があります Xcodeでコマンドプラグインを使用したので次はプラグインの仕組みを詳細に見てみましょうパッケージプラグインはSwift スクリプトで必要な時にコンパイルされ実行されますそれぞれが個々のプロセスとして実行されプラグインはソースファイルを含む蒸留された入力パッケージにアクセスできまたパッケージの依存関係に関する情報も得ます多くのプラグインは作業の一般としてコマンドプラグインを呼び出しますプラグインはファイルやディレクトリを作成でき Foundationなど標準ライブラリを使い他の作業を実行できますプラグインはサンドボックスで実行しビルド出力ディレクトリなどファイルシステムで書ける場所は限られていますしかしコマンドプラグインはパッケージソースディレクトリでファイルの変更を要求できユーザが承認するとこれらのロケーションで書けるようサンドボックスが構成されますプラグインは結果をXcodeに返すこともでき警告やエラーを発すこともできますビルドツールプラグインは実行中にツールの呼び出しを定義することができますすべてのプラグインはXcodeが提供する PackagePluginモジュールのAPIを使用しますこのAPIはプラグインの入力パッケージへのアクセスを許可し適切であれば結果をXcodeに返しますプラグインを実装するメインソースファイルもメインエントリポイントを定義しますこれはプロトコルに適合しプラグインの型に一致する class または structである必要があります Xcodeが呼び出す特定のエントリポイント関数はプラグインの種類によって異なります PackagePlugin APIの詳細については『Swift Packageプラグインを作成する』先程コマンドプラグインを使用してパッケージに変更を行いましたコマンドプラグインの詳細を見てみましょうコマンドプラグインは開発ワークフローを拡張しますビルド中ではなくパッケージに直接適用されますファイルシステムを変更しないものもありますファイルにいかなる変更を加えない便利なアクションがありますしかしコマンドがファイルシステムに書きたい場合プラグインを実装したパッケージのマニフェストに宣言する必要がありますこれにより Xcodeはプラグインが実行される前にユーザに許可をリクエストしますプラグインは通常小型で実際の作業を行うには他のツールに依存します先程プラグインの１つが実際の仕事のすべてに SwiftFormatを使用していましたねツールパッケージの依存関係はバイナリまたはソースコードになります Xcodeはコマンドが呼び出される前にソースから必要なツールを作成しますプラグインは依存するツールではなく他のパッケージから提供される場合もありますコマンドプラグインの実装ではメイン型はCommandPluginプロトコルに適合しプラグインはperformCommand エントリポイントを実装しますこのエントリポイントはコンテキストとユーザが提供した引数を取り入れますコマンドプラグインを別の方法で呼び出しましょうまた同じプロジェクトを使い SourceCodeUtilitiesパッケージに依存関係を追加しているのでターミナルの同じプラグインを呼び出しますまずディレクトリをCoreLibsパッケージに変えますこのパッケージにコマンドプラグインを適用したいからです Package Manager 5.6には新しいサブコマンドがあり「swift package plugin --List」と入力して利用可能なプラグインを探します Xcodeのメニューと同じプラグインが表示されましたこのコマンドラインでは各コマンドが実行するための動詞を表示しています Xcodeでやったように寄稿者リストの「再生」という動詞を選択しますプラグインはファイルを作成するため入力の許可をリクエストしています「yes」を入力して許可しプラグインが実行してリストを更新します許可を必要とせずプラグインがファイルシステムに書くことができるパッケージマネージャを使うこともできましたこれはCIシステムや他のビルド自動化から呼び出す場合に便利ですしかしそのオプションを使用する前にプラグインの作業内容を把握してください Xcodeと同じようにコマンドライン引数をプラグインにパスしますプラグインの動作動詞の後の引数はプラグインにパスされますこの場合詳細フラグをパスしてプラグイン実行中の出力を確認します各コマンドプラグインはその引数を定義しますコマンドラインプラグインだけでなくビルドツールプラグインについてもお伝えしたいことがありますコマンドプラグインとは異なりビルドツールプラグインは即座に作業を行いません代わりにパッケージが構築された後でXcodeが実行されるようにビルドツールを呼び出し変換します各ツールの呼び出しには実行のコマンドラインがあり Xcodeに実行することを伝える入力と出力がありますビルド中やビルド前に実行するコマンドを定義できます違いはこの後すぐにお見せします
ビルドツールプラグインが返したコマンドは通常漸進的なビルドで持続できるようビルドディレクトリに出力を書くよう構成されますプラグインのようにビルドツールプラグインが定義したコマンドはサンドボックスで実行されネットワークアクセスやパッケージの変更を防止しますビルドツールプラグインの実装ではメイン型は BuildTool Plugin プロトコルに適合しプラグインはcreateBuildCommandsを実装しますこのエントリポイントはビルドコマンドの作成にコンテキストとターゲットを取り入れますパッケージが構築された時に実行されるべきカスタムビルドコマンドを返還しますビルドツールプラグインが返還する基本的なコマンドが２つあります Ordinaryビルドコマンドは入出力のパスを指定し出力が見つからない場合や入力が変更された場合のみ実行します Prebuildコマンドはビルド開始前に実行し出力名が事前にわからない場合に使用することもできます Prebuildはすべてのビルド前に実行するので変化がない場合は作業を最小限に抑えてくださいビルドコマンドとプリビルドコマンドはソースコードやリソースの生成に最適ですではXcodeはどのようにプラグインを選択してパッケージターゲットに適用するのでしょうか SwiftPM 5.6 以降ではパッケージマニフェストに新しいプラグインパラメータがありターゲットが望むプラグインをリスト付けしますこのパラメータはターゲットが必要とするビルドツールプラグインを指定しランタイムライブラリが依存するようにこれらのプラグインは同じパッケージにも別のパッケージにも存在できます Xcodeに戻りましょう私の図形描画Appでビルドツールプラグインを使用してみますこの特定の場合では Core Libraryターゲットのデータファイルに基づいて Swiftコードを生成するコマンドラインツールがあり具体的な内容は重要ではありませんが最終的に求めているのはそれぞれのデータに対する生成された型安全のSwift アクセサですデータファイルに加えカスタムツールを使用しリポジトリにあるソースコードを生成しますこのツールを手動で実行し Swiftラッパーコードを再生しデータファイルが変更するたびに変更を寄稿してきましたがビルドツールプラグインでさらにいい仕事ができますビルド中にコードを生成しリポジトリにそのコードが保管されないようにします
プラグインにアクセスしますパッケージマニフェストで使用したいソース生成プラグインを提供するパッケージに依存関係を作ります
これでパッケージのターゲットはビルドツールプラグインにアクセスできます
プラグインの使用が必要なターゲットで定義にプラグインパラメータを追加します
これでXcodeにそのパッケージの到底なツールをターゲットに適用することが伝わりますこれでリポジトリから生成されたソースファイルを削除できるようになりました必要に応じてビルド中に作成・更新が可能です
これでわかりやすくなりました Appを構築して実行するとビルドツールプラグインはデータファイルが変更するたびにXcodeにコード生成ツールを呼び出すよう要求します生成されたコードはビルドフォルダで他のビルドファイルと共に保管されリポジトリはきれいに整理されますこのビデオではSwiftパッケージのプラグインとは何かそして機能について説明しましたコマンドプラグインとビルドツールプラグインの類似性と相違性について説明しましたどちらのプラグインもさまざまな無作為のスクリプトをより構造的な拡張機能に置き換える能力がありますビルドツールプラグインはソースやリソースの生成またはビルドの一部としてその他のカスタム動作ができるよう拡張してくれますコマンドプラグインは一般的な開発タスクをカスタムアクションで自動化してくれますどちらも特定のワークフローに最適で広範囲のケースで書くこともできますパッケージプラグインの作成方法については『Swift Packageプラグインを作成する』をご覧くださいご清聴ありがとうございました ♪

6:59 - General structure of a package plugin with conditional support for Xcode projects when running in Xcode

import PackagePlugin

@main
struct MyPlugin: ... {

    // Entry points specific to plugin capability. These entry points are invoked
    // when the plugin is applied to a package.

}

#if canImport(XcodeProjectPlugin)
import XcodeProjectPlugin

extension MyPlugin: ... {

    // Entry points specific to plugin capability. These entry points are invoked
    // when the plugin is applied to an Xcdeo project.

}
#endif

8:33 - Structure of a command plugin with conditional support for Xcode projects when running in Xcode

import PackagePlugin

@main
struct MyPlugin: CommandPlugin {

    /// This entry point is called when operating on a Swift package.
    func performCommand(context: PluginContext, arguments: [String]) throws {
        debugPrint(context)
    }
}

#if canImport(XcodeProjectPlugin)
import XcodeProjectPlugin

extension MyPlugin: XcodeCommandPlugin {

    /// This entry point is called when operating on an Xcode project.
    func performCommand(context: XcodePluginContext, arguments: [String]) throws {
        debugPrint(context)
    }
}
#endif

11:13 - Structure of a build tool plugin with conditional support for Xcode projects when running in Xcode

import PackagePlugin

@main
struct MyPlugin: BuildToolPlugin {

    /// This entry point is called when operating on a Swift package.
    func createBuildCommands(context: PluginContext, target: Target) throws -> [Command]
        debugPrint(context)
        return []
    }
}

#if canImport(XcodeProjectPlugin)
import XcodeProjectPlugin

extension MyPlugin: XcodeBuildToolPlugin {

    /// This entry point is called when operating on an Xcode project.
    func createBuildCommands(context: XcodePluginContext, target: XcodeTarget) throws -> [Command]
        debugPrint(context)
        return []
    }
}
#endif

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC23

WWDC22

WWDC19