もちゅろぐ
iOS
XcodeGen
XcodeGenのSettings周りを整理する

XcodeGenのSettings周りを整理する

2020-7-29

Table of Contents

Settingsとは？
ビルド設定はプロジェクトとターゲットで出来る
ビルド設定の値の解決方法
Build Configuration別でビルドパラメータを設定できる
Build Configurationにも適用されるbaseプロパティがある
settingGroupsでビルド設定を共通化できる
Xcode同様に自動で適用されるプリセットビルド設定がある
ビルド設定群を別ファイル(xcconfig)として抜き出せる
結論

XcodeGenは便利ですが、プロジェクト仕様ファイル(project.yml)のSettingsに関して自分の中で不透明なので整理しました。

Settingsとは？

XcodeGenのプロジェクト仕様ファイル内で使えるビルド設定を定義するプロパティと総称。

settingsはプロジェクトとターゲットの2箇所で使える
ビルド設定の値の解決はレベル順となっている
Build Configuration(DebugやReleaseなど)別でビルドパラメータを設定できる
Build Configurationにも適用されるbaseプロパティがある
settingGroupsでビルド設定を共通化できる
Xcode同様に自動で適用されるプリセットビルド設定がある
ビルド設定群を別ファイル(xcconfig)として抜き出せる

ビルド設定はプロジェクトとターゲットで出来る

例えば次のプロジェクト仕様はプロジェクトとMyAppターゲットそれぞれでビルド設定をセットしています。

settings:
  SWIFT_ACTIVE_COMPILATION_CONDITIONS: [project_value]
targets:
  MyApp:
    settings:
      SWIFT_ACTIVE_COMPILATION_CONDITIONS: [target_value]

ビルド設定の値の解決方法

ビルド設定の値はレベル順に見ていってる。

Target
Target xcconfig file
Project
Project xcconfig file
SDK defaults

Targetの設定が一番強く、下に行くほど範囲は広いが上書きされる。

検証するために次のプロジェクト仕様で確認する。

name: Settings
options:
  bundleIdPrefix: com.mothule
settings:
  SWIFT_ACTIVE_COMPILATION_CONDITIONS: [DEBUG, project_value]


targets:
  Settings:
    type: application
    platform: iOS
    sources: Settings
    settings:
      SWIFT_ACTIVE_COMPILATION_CONDITIONS: [DEBUG, target_value]

これを実際にXcodeで確認するとこうなる。

想定通り、Settingsターゲットでは値はtarget_valueで解決されてる。
この挙動に関しては理解は容易と言える。

Build Configuration別でビルドパラメータを設定できる

DebugやReleaseなどBuild Configuration別でビルド設定を変えることができます。
例えば下記はDebug時はDEBUGが定義され、Release時はRELEASEが定義されます。

targets:
  MyApp:
    settings:
      configs:
        Debug:
          SWIFT_ACTIVE_COMPILATION_CONDITIONS: [DEBUG]
        Release:
          SWIFT_ACTIVE_COMPILATION_CONDITIONS: [RELEASE]

Build Configurationにも適用される`base`プロパティがある

Build Configurationに依存せず設定したビルドパラメータを入れたい場合は、baseを使います。

configs:
  Debug: debug
  CI: debug
  Release: release
settings:
  base:
    DEVELOPMENT_TEAM: HogeHoge
  configs:
    Debug:
      SWIFT_ACTIVE_COMPILATION_CONDITIONS: [DEBUG]
    CI:
      SWIFT_ACTIVE_COMPILATION_CONDITIONS: [DEBUG, CI]
    Release:
      SWIFT_ACTIVE_COMPILATION_CONDITIONS: [RELEASE]

この場合はどのBuild ConfigurationであってもDEVELOPMENT_TEAMはHogeHogeとなります。

`settingGroups`でビルド設定を共通化できる

例えばターゲットが5個あって、そのうち3つには同じビルド設定群がある場合、settingGroupsを使うことで設定箇所を1箇所にまとめることができます。

下記はsettingGroupsを使わなかったケースです。

targets:
  App1:
    settings:
      DEVELOPMENT_TEAM: HogeHoge
  App2:
    settings:
      DEVELOPMENT_TEAM: HogeHoge
  App3:
    settings:
      DEVELOPMENT_TEAM: HogeHoge
  DebugApp:
    settings:
      DEBUG_MODE: YES
  StgApp:
    settings:
      DEBUG_MODE: NO

これだと1箇所ずつ更新する必要があり、更新し忘れなどが発生します。
下記のようにsettingGroupsを使うことで情報を1箇所に集約することができます。

settingGroups:
  app: # ← 任意のグループ名
    settings:
      DEVELOPMENT_TEAM: HogeHoge
target:
  App1:
    settings:
      groups: [app]
  App2:
    settings:
      groups: [app]
  App3:
    settings:
      groups: [app]
  DebugApp:
    settings:
      DEBUG_MODE: YES
  StgApp:
    settings:
      DEBUG_MODE: NO

Xcode同様に自動で適用されるプリセットビルド設定がある

Xcodeがプロジェクトやターゲット追加時に自動で設定が設定されるのと同様に、XcodeGenにもプロジェクトとターゲットにデフォルト設定を設定する。
プロジェクトにはDebugとReleaseの設定が、ターゲットにはプラットフォームとプロダクトタイプに応じた設定が適用される。

これらのプリセットを変更・無効するにはoptions.settingPresetsプロパティを使います。
デフォルトではallとなっておりプロジェクトとターゲット両方に対して適用されています。
もしターゲットだけ、プロジェクトだけとしたい場合は、options.settingPresets: projectやtargetsとすることで部分適用されます。
もし両方とも自動適用を無効にする場合はnoneになります。

ビルド設定群を別ファイル(xcconfig)として抜き出せる

ビルド設定のボリュームが大きくなると、プロジェクト仕様全体として見通しの悪いファイルとなってしまいます。
その場合はconfigFilesを使ってxcconfigファイルをインポートしてビルド構成を別ファイルに抽出できます。

configFiles:
  Debug: debug.xcconfig
  Release: release.xcconfig
targets:
  MyApp:
    configFiles:
      Debug: MyApp/debug.xcconfig
      Release: MyApp/release.xcconfig