XcodeEditor は、Xcode のプロジェクトファイル（.xcodeproj）をプログラムから安全に操作するための Objective-C ライブラリです。手動での项目ファイル編集は競合や破損のリスクを伴いますが、この API を利用することで、ファイルの追加、ターゲット設定、ビルド構成の変更などをコードベースで管理できるようになります。特に CI/CD パイプラインの構築や、複数プロジェクトへの一括設定適用において効果を発揮します。

ライブラリの導入方法

プロジェクトへの組み込みは、CocoaPods を利用するか、ソースコードを直接インポートする方法があります。公式リポジトリからソースを取得し、ビルドターゲットに追加してください。

git clone https://github.com/tuist/XcodeEditor.git

基本的なプロジェクト操作

操作を開始するには、まず対象のプロジェクトファイルパスを指定してインスタンスを生成します。

XCProject* workspace = [[XCProject alloc] initWithFilePath:@"EnterpriseApp.xcodeproj"];

この初期化処理により、プロジェクト構造がメモリ上に読み込まれ、各種メソッドによる編集が可能になります。

主要機能の実装例

ソースファイルの追加

特定のグループ配下に新しいクラスファイルを作成し、プロジェクトへ登録する手順は以下の通りです。

XCGroup* targetGroup = [workspace groupWithPathFromRoot:@"Core"];
XCClassDefinition* newClass = [[XCClassDefinition alloc] initWithName:@"DataProcessor"];
[newClass setHeader:@"// Header content here"];
[newClass setSource:@"// Implementation content here"];
[targetGroup addClass:newClass];
[workspace save];

ターゲットの複製

既存のターゲット設定をベースに、新しい環境用のターゲットを迅速に作成できます。

XCTarget* baseTarget = [workspace targetWithName:@"DevTarget"];
XCTarget* newTarget = [baseTarget duplicateWithTargetName:@"ProdTarget" productName:@"EnterpriseAppProd"];

ビルド設定の修正

各ビルド構成に対して、ヘッダー検索パスなどの設定値 programmatically に注入できます。

XCTarget* activeTarget = [workspace targetWithName:@"EnterpriseApp"];
for (NSString* schemeName in [activeTarget configurations]) {
    XCBuildConfiguration* buildConfig = [activeTarget configurationWithName:schemeName];
    NSMutableArray* includePaths = [[NSMutableArray alloc] init];
    [includePaths addObject:@"$(inherited)"];
    [includePaths addObject:@"$(SRCROOT)/Frameworks"];
    [buildConfig addOrReplaceSetting:includePaths forKey:@"HEADER_SEARCH_PATHS"];
}

設定キーには、OTHER_LD_FLAGS や CODE_SIGN_IDENTITY なども指定可能です。

リソースファイルの登録

画像などのアセットファイルをプロジェクトに含める場合、以下のように定義します。

XCSourceFileDefinition* assetDef = [[XCSourceFileDefinition alloc]
    initWithName:@"logo_dark.png" data:[NSData dataWithContentsOfFile:@"./assets/logo_dark.png"]
    type:ImageResourcePNG];
[targetGroup addSourceFile:assetDef];
[workspace save];

高度な制御オプション

ファイル書き込み戦略

既存ファイルとの競合处理方式を定義することで、予期しない上書きを防ぐことができます。

// 既存ファイルがあれば上書き
[definition setFileOperationStyle:FileOperationStyleOverwrite];

// 既存ファイルを優先し新規作成しない
[definition setFileOperationStyle:FileOperationStyleAcceptExisting];

// プロジェクト参照のみ追加し物理ファイルは作成しない
[definition setFileOperationStyle:FileOperationStyleReferenceOnly];

サブプロジェクトの管理

複雑な構成において、サブプロジェクトのリンク追加や削除も API で制御可能です。

// サブプロジェクトの追加
XCSubProjectDefinition* vendorLib = [XCSubProjectDefinition withName:@"VendorLib" projPath:@"/Libs/Vendor" type:XcodeProject];
[targetGroup addSubProject:vendorLib toTargets:[workspace targets]];

// サブプロジェクトの移除
[targetGroup removeSubProject:vendorLib];

環境要件とライセンス

本ライブラリは Xcode 4 以降および JetBrains AppCode での動作が確認されています。ARC および MRR どちらのメモリ管理モデルにも対応しています。ソースコードは Apache License 2.0 の下で公開されており、商用・非商用を問わず利用可能です。