XcodeGenを導入するにあたりお世話になった記事3選

XcodeGenを導入するぞ!といっても、最初は何から手を付けていいのかわからない人が多いのではないでしょうか?

私も最初はそんな状態でしたが、先人の皆さまが素晴らしい記事を残してくれていたので、年季の入った大規模なプロジェクトにもかかわらずXcodeGen導入をすることができました。

本記事では私が大変お世話になった記事を3つご紹介します。

3つって少なくない?と思うかもしれないですが、実際これだけあれば十分でした!



mikanのiOSプロジェクトにXcodeGenを導入しました。

note.com


こちらの記事では、XcodeGen導入にあたり気をつけるべきことを簡潔にまとめてくれています。

XcodeGenの導入にあたって使用すると便利なツールがいくつか紹介されているのですが、細かい使い方の說明ではなく、どういう課題があってその課題に対してツールがどのように有効なのかがわかりやすく解説されています。


ここで紹介されている以下2つのツールは大変便利で、XcodeGen導入においては必須と言えるツールです。

github.com

github.com


Sansan iOS アプリに XcodeGen を導入しました

buildersbox.corp-sansan.com


1つ目に紹介した記事をもとにproject.ymlを書き始めたのですが、私が相手にしていたのは7、8年もののXcodeプロジェクトでして、一から書いていたのではいつまでも終わりそうにない状態でした。。

そこでこの記事を見つけ読んでいると、project.ymlの自動生成機能が紹介されていて、大変助けられました。


さらに、Tipsとして紹介されているものはどれもとても参考になります。

project.ymlはかなり膨大になるのである程度の単位で細かくファイルを分けると思うのですが、ディレクトリ構成やスクリプトの配置場所などはかなり参考にさせていただきました(というかほぼそのまま採用)。

チームでXcodeGenを運用していくための工夫も参考になります。

たしかに、最初はXcodeGenを導入した人しか詳しくないわけで、チームで運用していくためにはYAMLファイルの書き方をルール化したり、Xcodeのプロジェクト生成を楽にしたりといった工夫が必要です。

そのあたりの具体的な方法が紹介されているので、チームで運用していくことを考えている人は参考になると思います。


プロジェクトファイルからXcodeGenのproject.ymlを生成する

qiita.com


既存のXcodeプロジェクトファイルからproject.ymlを自動生成する機能があり、それについて解説してくれている記事です。

自動生成機能は2021年12月現在でまだDraft PR状態ですが、Draftとはいえかなり使えるものになっているので絶対使ったほうがいいです。


生成されたproject.ymlを見ると、Build Settingsの内容がかなり膨大です。

その中には明示的に指定しなくても良いものも多々あり、上記記事を参考にproject.ymlの記載を減らしていきました。

記事にも記載がありますが、自動生成機能はまだ完全に機能するわけではないものの、ある程度期間が経っているプロジェクトにXcodeGenを導入するなら是非使ってみるべきです。

いきなりproject.ymlを書こうとしても終わりが見えずに途方にくれることになるので、まずは自動生成機能でproject.ymlを生成し、ちょこちょこ直してビルドできる状態まで持っていくところから始めるのがオススメです。


おわりに

私がXcodeGenを導入するにあたりお世話になった記事を3つご紹介しました。

XcodeGenはかなり使われるツールになってきていて発信されている情報は多いので、他にも参考になる記事はたくさんあると思います。

みなさんがお世話になった記事はどれでしょうか?

コメントで教えていただけると嬉しいです!