Adding options to make embedding of frameworks (i.e.: iOS 8 custom frameworks) as well as linking (i.e.: skipping it for header-only frameworks) optional.

Author: Roberto Andrade

lib/pbxProject.js

@@ -270,13 +270,24 @@ pbxProject.prototype.addFramework = function(fpath, opt) {
 
     if (this.hasFile(file.path)) return false;
 
+    var customFramework = opt && opt.customFramework == true;
+    var link = !opt || (opt.link == undefined || opt.link);    //defaults to true if not specified
+    var embed = opt && opt.embed;                              //defaults to false if not specified
+
     this.addToPbxBuildFileSection(file);        // PBXBuildFile
     this.addToPbxFileReferenceSection(file);    // PBXFileReference
     this.addToFrameworksPbxGroup(file);         // PBXGroup
-    this.addToPbxFrameworksBuildPhase(file);    // PBXFrameworksBuildPhase
 
-    if (opt && opt.customFramework == true) {
+    if (link) {
+      this.addToPbxFrameworksBuildPhase(file);    // PBXFrameworksBuildPhase
+    }
+
+    if (customFramework) {
         this.addToFrameworkSearchPaths(file);
+
+        if (embed) {
+          this.addToPbxEmbedFrameworksBuildPhase(file); // PBXCopyFilesBuildPhase
+        }
     }
 
     return file;
@@ -286,10 +297,11 @@ pbxProject.prototype.removeFramework = function(fpath, opt) {
     var file = new pbxFile(fpath, opt);
     file.target = opt ? opt.target : undefined;
 
-    this.removeFromPbxBuildFileSection(file);        // PBXBuildFile
-    this.removeFromPbxFileReferenceSection(file);    // PBXFileReference
-    this.removeFromFrameworksPbxGroup(file);         // PBXGroup
-    this.removeFromPbxFrameworksBuildPhase(file);    // PBXFrameworksBuildPhase
+    this.removeFromPbxBuildFileSection(file);          // PBXBuildFile
+    this.removeFromPbxFileReferenceSection(file);      // PBXFileReference
+    this.removeFromFrameworksPbxGroup(file);           // PBXGroup
+    this.removeFromPbxFrameworksBuildPhase(file);      // PBXFrameworksBuildPhase
+    this.removeFromPbxEmbedFrameworksBuildPhase(file); // PBXCopyFilesBuildPhase
 
     if (opt && opt.customFramework) {
         this.removeFromFrameworkSearchPaths(path.dirname(fpath));
@@ -578,6 +590,24 @@ pbxProject.prototype.removeFromFrameworksPbxGroup = function(file) {
     }
 }
 
+pbxProject.prototype.addToPbxEmbedFrameworksBuildPhase = function (file) {
+    var sources = this.pbxEmbedFrameworksBuildPhaseObj(file.target);
+    if (sources) {
+        sources.files.push(pbxBuildPhaseObj(file));
+    }
+}
+
+pbxProject.prototype.removeFromPbxEmbedFrameworksBuildPhase = function (file) {
+    var sources = this.pbxEmbedFrameworksBuildPhaseObj(file.target);
+    if (sources) {
+        for (i in sources.files) {
+            if (sources.files[i].comment == longComment(file)) {
+                sources.files.splice(i, 1);
+                break;
+            }
+        }
+    }
+}
 
 pbxProject.prototype.addToProductsPbxGroup = function(file) {
     var productsGroup = this.pbxGroupByName('Products');
@@ -905,6 +935,10 @@ pbxProject.prototype.pbxFrameworksBuildPhaseObj = function(target) {
     return this.buildPhaseObject('PBXFrameworksBuildPhase', 'Frameworks', target);
 }
 
+pbxProject.prototype.pbxEmbedFrameworksBuildPhaseObj = function (target) {
+    return this.buildPhaseObject('PBXCopyFilesBuildPhase', 'Embed Frameworks', target);
+};
+
 // Find Build Phase from group/target
 pbxProject.prototype.buildPhase = function(group, target) {
 
@@ -1166,14 +1200,14 @@ pbxProject.prototype.removeFromOtherLinkerFlags = function (flag) {
     var configurations = nonComments(this.pbxXCBuildConfigurationSection()),
         OTHER_LDFLAGS = 'OTHER_LDFLAGS',
         config, buildSettings;
-    
+
     for (config in configurations) {
         buildSettings = configurations[config].buildSettings;
-        
+
         if (unquote(buildSettings['PRODUCT_NAME']) != this.productName) {
             continue;
         }
-        
+
         if (buildSettings[OTHER_LDFLAGS]) {
             var matches = buildSettings[OTHER_LDFLAGS].filter(function (p) {
                 return p.indexOf(flag) > -1;
@@ -1192,7 +1226,7 @@ pbxProject.prototype.addToBuildSettings = function (buildSetting, value) {
 
     for (config in configurations) {
         buildSettings = configurations[config].buildSettings;
-        
+
         buildSettings[buildSetting] = value;
     }
 }
@@ -1203,7 +1237,7 @@ pbxProject.prototype.removeFromBuildSettings = function (buildSetting) {
 
     for (config in configurations) {
         buildSettings = configurations[config].buildSettings;
-        
+
         if (buildSettings[buildSetting]) {
             delete buildSettings[buildSetting];
         }
@@ -1245,22 +1279,22 @@ pbxProject.prototype.addTarget = function(name, type, subfolder) {
         targetType = type,
         targetSubfolder = subfolder || name,
         targetName = name.trim();
-        
+
     // Check type against list of allowed target types
     if (!targetName) {
         throw new Error("Target name missing.");
-    }    
+    }
 
     // Check type against list of allowed target types
     if (!targetType) {
         throw new Error("Target type missing.");
-    } 
+    }
 
     // Check type against list of allowed target types
     if (!producttypeForTargettype(targetType)) {
         throw new Error("Target type invalid: " + targetType);
     }
-    
+
     // Build Configuration: Create
     var buildConfigurationsList = [
         {

test/addFramework.js

@@ -128,7 +128,7 @@ exports.addFramework = {
         test.equal(buildFileEntry.fileRef, newFile.fileRef);
         test.equal(buildFileEntry.fileRef_comment, 'libsqlite3.dylib');
         test.deepEqual(buildFileEntry.settings, { ATTRIBUTES: [ 'Weak' ] });
-        
+
         test.done();
     },
     'should add to the Frameworks PBXGroup': function (test) {
@@ -155,6 +155,13 @@ exports.addFramework = {
         test.equal(frameworks.files.length, 16);
         test.done();
     },
+    'should not add to the PBXFrameworksBuildPhase': function (test) {
+        var newFile = proj.addFramework('Private.framework', {link: false}),
+            frameworks = proj.pbxFrameworksBuildPhaseObj();
+
+        test.equal(frameworks.files.length, 15);
+        test.done();
+    },
     'should have the right values for the Sources entry': function (test) {
         var newFile = proj.addFramework('libsqlite3.dylib'),
             frameworks = proj.pbxFrameworksBuildPhaseObj(),
@@ -188,12 +195,26 @@ exports.addFramework = {
         // should add path to framework search path
         var frameworkPaths = frameworkSearchPaths(proj);
             expectedPath = '"\\"/path/to\\""';
-        
+
         for (i = 0; i < frameworkPaths.length; i++) {
             var current = frameworkPaths[i];
             test.ok(current.indexOf('"$(inherited)"') >= 0);
             test.ok(current.indexOf(expectedPath) >= 0);
         }
         test.done();
-    }
+    },
+    'should add to the Embed Frameworks PBXCopyFilesBuildPhase': function (test) {
+        var newFile = proj.addFramework('/path/to/SomeEmbeddableCustom.framework', {customFramework: true, embed: true}),
+            frameworks = proj.pbxEmbedFrameworksBuildPhaseObj();
+
+        test.equal(frameworks.files.length, 1);
+        test.done();
+    },
+    'should not add to the Embed Frameworks PBXCopyFilesBuildPhase by default': function (test) {
+        var newFile = proj.addFramework('/path/to/Custom.framework', {customFramework: true}),
+            frameworks = proj.pbxEmbedFrameworksBuildPhaseObj();
+
+        test.equal(frameworks.files.length, 0);
+        test.done();
+    },
 }