🚀

Swift Macrosが難しいからスーパーシンプルなマクロ作った

2024/04/29に公開

Swift

SUMMARY

Swift Macrosの公式ドキュメントが難しすぎたので、
スーパーシンプルなマクロリポジトリを作ったよってお話です。
本当に簡単な要素しか入れていないので、
Swift-Syntaxよく知らないけど話題のSwift Macrosどんなもんよって方に見てもらえれば幸いです。

はじまり

ちょっとしたきっかけがあったので、Swift Macrosやるかーってなったんですが、

状態になった。

頑張ってまとめたのがこのスクラップ

スーパーシンプルなマクロを作ろう

自分にはレベルが高すぎて、文章だけだと理解が追いつかないので、
実際にリポジトリ作ってスーパーシンプルなマクロを作ってみました。

文字列を渡すと　Hello World を追加してくれるというマクロ

全体構成

.
├── .gitignore
├── hello-world-macro.xcworkspace
├── HelloWorld
│  ├── Sandbox
│  │  ├── Assets.xcassets
│  │  ├── Preview Content
│  │  └── SandboxApp.swift
│  └── Sandbox.xcodeproj
├── LICENSE
├── packages
│  ├── Package.swift
│  ├── Sources
│  │  ├── App
│  │  ├── Macros
│  │  └── Plugins
│  └── Tests
│     └── PluginTests
└── README.md

全体的なファイル構成はこんな感じになってます。
今回はアプリにマクロを組み込むという状況で設計しているので、
アプリ本体部とマクロ部に別れています。
また、プロジェクト自体はSwiftPMでパッケージ分離しています。
マクロを実装するのにSwiftPM経由でしか入れられないので、ちょうど良いですね。

HelloWorldフォルダ

アプリのmainファイルやその他構成ファイルを管理しているフォルダです。
今回の内容的にあんまり見るところはないと思います。

packagesフォルダ

アプリの実装を持っているSwiftPMで管理されるフォルダです。
Sourcesフォルダの中のフォルダ単位でSwiftPM上でPackage管理されます。

App Package

今回は一画面しか持たないので、アプリの画面としてはこのPackageだけがアプリのPackageとなっています。
作成したマクロを実際に適用する画面を持っているPackageになります。

Macros Package

実行ファイルとしてはマクロの定義ファイルのみのPackageになります。
Unit Testしたかったので、Testプランのファイルも入っています。

Plugin Package

マクロの実装部を格納するPackageです。
このリポジトリで一番重要なPackageになります。

マクロ実装内容

マクロ定義

今回は　自立型マクロ(Freestanding Macros) で作成しています。

@freestanding(expression) を指定することで自立型マクロとして定義できます。

マクロ実装

Plugin/HelloWorld.swiftの中で、実際の動作を実装しています。
引数で取得できた文字列の接頭辞に Hello World、接尾辞に !!! を追加するだけの簡単な内容です。

ユニットテスト

Package.swiftの構成上、Plugins Packageのテストとして PluginTests を設定しているんですが、Unit Test上ではPlugins Packageの参照ができずビルドエラーになってしまう状態で困っていたんですが、

こちらのコメントでもあるように、マクロのテストは Mac を指定しないとダメなようです(大抵の場合　My Mac になるんですかね🤔）

まとめ

これで今回作成したリポジトリの説明は終わりです。
かなりシンプルな構成にしましたが、Swift Macros自体の扱いが結構難しいですね😅
次は付属型のマクロを~~作ってみようかと思っています🤔~~ 👈作りました！！

ぜひこっちもみてください🙏