fix: prepare xcconfig files for all conigurations

    Currently CLI merges and prepares xcconfig files only for the current build configuration, i.e. debug or release. However, the `pod install` command works with both configurations. This leads to problem when some property is set in the project's (plugin's) build.xcconfig file as CLI will prepare the native iOS project only for one configuration. When `pod install` is executed, if the Pods project uses the property set in the build.xcconfig file, it will fail with error, as the value for debug and release will be different (i.e. it will be set only for one of them). Pods project does not support this behavior, so the build operation fails.

    So, ensure CLI merges all xcconfig files for both debug and release configurations. This way, the Pods project will be in sync, so it should continue its execution. This is important when using Cocoapods 1.6.0+ where some changes are applied for Swift support, which can be workarounded by setting SWIFT_VERSION in project's build.xcconfig file.

Author: rosen-vladimirov

lib/declarations.d.ts

@@ -890,12 +890,11 @@ interface IXcprojInfo {
 
 interface IXcconfigService {
 	/**
-	 * Returns the path to the xcconfig file
+	 * Returns the paths to the xcconfig files for build configuration (debug/release)
 	 * @param projectRoot The path to root folder of native project (platforms/ios)
-	 * @param opts
-	 * @returns {string}
+	 * @returns {IStringDictionary}
 	 */
-	getPluginsXcconfigFilePath(projectRoot: string, opts: IRelease): string;
+	getPluginsXcconfigFilePaths(projectRoot: string): IStringDictionary;
 
 	/**
 	 * Returns the value of a property from a xcconfig file.

lib/services/cocoapods-service.ts

@@ -55,14 +55,16 @@ export class CocoaPodsService implements ICocoaPodsService {
 		return podInstallResult;
 	}
 
-	public async mergePodXcconfigFile(projectData: IProjectData, platformData: IPlatformData, opts: IRelease) {
+	public async mergePodXcconfigFile(projectData: IProjectData, platformData: IPlatformData): Promise<void> {
 		const podFilesRootDirName = path.join("Pods", "Target Support Files", `Pods-${projectData.projectName}`);
 		const podFolder = path.join(platformData.projectRoot, podFilesRootDirName);
 		if (this.$fs.exists(podFolder)) {
-			const podXcconfigFilePath = opts && opts.release ? path.join(podFolder, `Pods-${projectData.projectName}.release.xcconfig`)
-				: path.join(podFolder, `Pods-${projectData.projectName}.debug.xcconfig`);
-			const pluginsXcconfigFilePath = this.$xcconfigService.getPluginsXcconfigFilePath(platformData.projectRoot, opts);
-			await this.$xcconfigService.mergeFiles(podXcconfigFilePath, pluginsXcconfigFilePath);
+			const pluginsXcconfigFilePaths = this.$xcconfigService.getPluginsXcconfigFilePaths(platformData.projectRoot);
+			for (const configuration in pluginsXcconfigFilePaths) {
+				const pluginsXcconfigFilePath = pluginsXcconfigFilePaths[configuration];
+				const podXcconfigFilePath = path.join(podFolder, `Pods-${projectData.projectName}.${configuration}.xcconfig`);
+				await this.$xcconfigService.mergeFiles(podXcconfigFilePath, pluginsXcconfigFilePath);
+			}
 		}
 	}
 

lib/services/ios-project-service.ts

@@ -799,7 +799,7 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 	public async processConfigurationFilesFromAppResources(projectData: IProjectData, opts: IRelease): Promise<void> {
 		await this.mergeInfoPlists(projectData, opts);
 		await this.$iOSEntitlementsService.merge(projectData);
-		await this.mergeProjectXcconfigFiles(projectData, opts);
+		await this.mergeProjectXcconfigFiles(projectData);
 		for (const pluginData of await this.getAllInstalledPlugins(projectData)) {
 			await this.$pluginVariablesService.interpolatePluginVariables(pluginData, this.getPlatformData(projectData).configurationFilePath, projectData.projectDir);
 		}
@@ -1216,43 +1216,54 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 		this.$fs.writeFile(path.join(headersFolderPath, "module.modulemap"), modulemap);
 	}
 
-	private async mergeProjectXcconfigFiles(projectData: IProjectData, opts: IRelease): Promise<void> {
+	private async mergeProjectXcconfigFiles(projectData: IProjectData): Promise<void> {
 		const platformData = this.getPlatformData(projectData);
-		const pluginsXcconfigFilePath = this.$xcconfigService.getPluginsXcconfigFilePath(platformData.projectRoot, opts);
-		this.$fs.deleteFile(pluginsXcconfigFilePath);
+		const pluginsXcconfigFilePaths = _.values(this.$xcconfigService.getPluginsXcconfigFilePaths(platformData.projectRoot));
+
+		for (const pluginsXcconfigFilePath of pluginsXcconfigFilePaths) {
+			this.$fs.deleteFile(pluginsXcconfigFilePath);
+		}
 
 		const pluginsService = <IPluginsService>this.$injector.resolve("pluginsService");
 		const allPlugins: IPluginData[] = await pluginsService.getAllInstalledPlugins(projectData);
 		for (const plugin of allPlugins) {
 			const pluginPlatformsFolderPath = plugin.pluginPlatformsFolderPath(IOSProjectService.IOS_PLATFORM_NAME);
 			const pluginXcconfigFilePath = path.join(pluginPlatformsFolderPath, BUILD_XCCONFIG_FILE_NAME);
 			if (this.$fs.exists(pluginXcconfigFilePath)) {
-				await this.$xcconfigService.mergeFiles(pluginXcconfigFilePath, pluginsXcconfigFilePath);
+				for (const pluginsXcconfigFilePath of pluginsXcconfigFilePaths) {
+					await this.$xcconfigService.mergeFiles(pluginXcconfigFilePath, pluginsXcconfigFilePath);
+				}
 			}
 		}
 
 		const appResourcesXcconfigPath = path.join(projectData.appResourcesDirectoryPath, this.getPlatformData(projectData).normalizedPlatformName, BUILD_XCCONFIG_FILE_NAME);
 		if (this.$fs.exists(appResourcesXcconfigPath)) {
-			await this.$xcconfigService.mergeFiles(appResourcesXcconfigPath, pluginsXcconfigFilePath);
+			for (const pluginsXcconfigFilePath of pluginsXcconfigFilePaths) {
+				await this.$xcconfigService.mergeFiles(appResourcesXcconfigPath, pluginsXcconfigFilePath);
+			}
 		}
 
-		if (!this.$fs.exists(pluginsXcconfigFilePath)) {
-			// We need the pluginsXcconfig file to exist in platforms dir as it is required in the native template:
-			// https://github.com/NativeScript/ios-runtime/blob/9c2b7b5f70b9bee8452b7a24aa6b646214c7d2be/build/project-template/__PROJECT_NAME__/build-debug.xcconfig#L3
-			// From Xcode 10 in case the file is missing, this include fails and the build itself fails (was a warning in previous Xcode versions).
-			this.$fs.writeFile(pluginsXcconfigFilePath, "");
+		for (const pluginsXcconfigFilePath of pluginsXcconfigFilePaths) {
+			if (!this.$fs.exists(pluginsXcconfigFilePath)) {
+				// We need the pluginsXcconfig file to exist in platforms dir as it is required in the native template:
+				// https://github.com/NativeScript/ios-runtime/blob/9c2b7b5f70b9bee8452b7a24aa6b646214c7d2be/build/project-template/__PROJECT_NAME__/build-debug.xcconfig#L3
+				// From Xcode 10 in case the file is missing, this include fails and the build itself fails (was a warning in previous Xcode versions).
+				this.$fs.writeFile(pluginsXcconfigFilePath, "");
+			}
 		}
 
-		// Set Entitlements Property to point to default file if not set explicitly by the user.
-		const entitlementsPropertyValue = this.$xcconfigService.readPropertyValue(pluginsXcconfigFilePath, constants.CODE_SIGN_ENTITLEMENTS);
-		if (entitlementsPropertyValue === null && this.$fs.exists(this.$iOSEntitlementsService.getPlatformsEntitlementsPath(projectData))) {
-			temp.track();
-			const tempEntitlementsDir = temp.mkdirSync("entitlements");
-			const tempEntitlementsFilePath = path.join(tempEntitlementsDir, "set-entitlements.xcconfig");
-			const entitlementsRelativePath = this.$iOSEntitlementsService.getPlatformsEntitlementsRelativePath(projectData);
-			this.$fs.writeFile(tempEntitlementsFilePath, `CODE_SIGN_ENTITLEMENTS = ${entitlementsRelativePath}${EOL}`);
-
-			await this.$xcconfigService.mergeFiles(tempEntitlementsFilePath, pluginsXcconfigFilePath);
+		for (const pluginsXcconfigFilePath of pluginsXcconfigFilePaths) {
+			// Set Entitlements Property to point to default file if not set explicitly by the user.
+			const entitlementsPropertyValue = this.$xcconfigService.readPropertyValue(pluginsXcconfigFilePath, constants.CODE_SIGN_ENTITLEMENTS);
+			if (entitlementsPropertyValue === null && this.$fs.exists(this.$iOSEntitlementsService.getPlatformsEntitlementsPath(projectData))) {
+				temp.track();
+				const tempEntitlementsDir = temp.mkdirSync("entitlements");
+				const tempEntitlementsFilePath = path.join(tempEntitlementsDir, "set-entitlements.xcconfig");
+				const entitlementsRelativePath = this.$iOSEntitlementsService.getPlatformsEntitlementsRelativePath(projectData);
+				this.$fs.writeFile(tempEntitlementsFilePath, `CODE_SIGN_ENTITLEMENTS = ${entitlementsRelativePath}${EOL}`);
+
+				await this.$xcconfigService.mergeFiles(tempEntitlementsFilePath, pluginsXcconfigFilePath);
+			}
 		}
 	}
 

lib/services/xcconfig-service.ts

@@ -1,17 +1,17 @@
 import * as path from "path";
+import { Configurations } from "../common/constants";
 
 export class XcconfigService implements IXcconfigService {
 	constructor(
 		private $childProcess: IChildProcess,
 		private $fs: IFileSystem,
 		private $xcprojService: IXcprojService) { }
 
-	public getPluginsXcconfigFilePath(projectRoot: string, opts: IRelease): string {
-		if (opts && opts.release) {
-			return this.getPluginsReleaseXcconfigFilePath(projectRoot);
-		}
-
-		return this.getPluginsDebugXcconfigFilePath(projectRoot);
+	public getPluginsXcconfigFilePaths(projectRoot: string): IStringDictionary {
+		return {
+			[Configurations.Debug.toLowerCase()]: this.getPluginsDebugXcconfigFilePath(projectRoot),
+			[Configurations.Release.toLowerCase()]: this.getPluginsReleaseXcconfigFilePath(projectRoot)
+		};
 	}
 
 	private getPluginsDebugXcconfigFilePath(projectRoot: string): string {

test/ios-project-service.ts

@@ -1178,17 +1178,19 @@ describe("Merge Project XCConfig files", () => {
 
 		// run merge for all release: debug|release
 		for (const release in [true, false]) {
-			await (<any>iOSProjectService).mergeProjectXcconfigFiles(projectData, { release });
+			await (<any>iOSProjectService).mergeProjectXcconfigFiles(projectData);
 
-			const destinationFilePath = xcconfigService.getPluginsXcconfigFilePath(projectRoot, { release: !!release });
+			const destinationFilePaths = xcconfigService.getPluginsXcconfigFilePaths(projectRoot);
 
-			assert.isTrue(fs.exists(destinationFilePath), 'Target build xcconfig is missing for release: ' + release);
-			const expected = {
-				'ASSETCATALOG_COMPILER_APPICON_NAME': 'AppIcon',
-				'ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME': 'LaunchImage',
-				'CODE_SIGN_IDENTITY': 'iPhone Distribution'
-			};
-			assertPropertyValues(expected, destinationFilePath, testInjector);
+			_.each(destinationFilePaths, destinationFilePath => {
+				assert.isTrue(fs.exists(destinationFilePath), 'Target build xcconfig is missing for release: ' + release);
+				const expected = {
+					'ASSETCATALOG_COMPILER_APPICON_NAME': 'AppIcon',
+					'ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME': 'LaunchImage',
+					'CODE_SIGN_IDENTITY': 'iPhone Distribution'
+				};
+				assertPropertyValues(expected, destinationFilePath, testInjector);
+			});
 		}
 	});
 
@@ -1206,13 +1208,15 @@ describe("Merge Project XCConfig files", () => {
 
 			await (<any>iOSProjectService).mergeProjectXcconfigFiles(projectData, { release });
 
-			const destinationFilePath = xcconfigService.getPluginsXcconfigFilePath(projectRoot, { release: !!release });
+			const destinationFilePaths = xcconfigService.getPluginsXcconfigFilePaths(projectRoot);
 
-			assert.isTrue(fs.exists(destinationFilePath), 'Target build xcconfig is missing for release: ' + release);
-			const expected = {
-				'CODE_SIGN_ENTITLEMENTS': iOSEntitlementsService.getPlatformsEntitlementsRelativePath(projectData)
-			};
-			assertPropertyValues(expected, destinationFilePath, testInjector);
+			_.each(destinationFilePaths, destinationFilePath => {
+				assert.isTrue(fs.exists(destinationFilePath), 'Target build xcconfig is missing for release: ' + release);
+				const expected = {
+					'CODE_SIGN_ENTITLEMENTS': iOSEntitlementsService.getPlatformsEntitlementsRelativePath(projectData)
+				};
+				assertPropertyValues(expected, destinationFilePath, testInjector);
+			});
 		}
 	});
 
@@ -1222,34 +1226,32 @@ describe("Merge Project XCConfig files", () => {
 		const xcconfigEntitlements = appResourceXCConfigContent + `${EOL}CODE_SIGN_ENTITLEMENTS = ${expectedEntitlementsFile}`;
 		fs.writeFile(appResourcesXcconfigPath, xcconfigEntitlements);
 
-		// run merge for all release: debug|release
-		for (const release in [true, false]) {
-			await (<any>iOSProjectService).mergeProjectXcconfigFiles(projectData, { release });
+		await (<any>iOSProjectService).mergeProjectXcconfigFiles(projectData);
 
-			const destinationFilePath = xcconfigService.getPluginsXcconfigFilePath(projectRoot, { release: !!release });
+		const destinationFilePaths = xcconfigService.getPluginsXcconfigFilePaths(projectRoot);
 
-			assert.isTrue(fs.exists(destinationFilePath), 'Target build xcconfig is missing for release: ' + release);
+		_.each(destinationFilePaths, destinationFilePath => {
+			assert.isTrue(fs.exists(destinationFilePath), `Target build xcconfig ${destinationFilePath} is missing.`);
 			const expected = {
 				'ASSETCATALOG_COMPILER_APPICON_NAME': 'AppIcon',
 				'ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME': 'LaunchImage',
 				'CODE_SIGN_IDENTITY': 'iPhone Distribution',
 				'CODE_SIGN_ENTITLEMENTS': expectedEntitlementsFile
 			};
 			assertPropertyValues(expected, destinationFilePath, testInjector);
-		}
+		});
 	});
 
 	it("creates empty plugins-<config>.xcconfig in case there are no build.xcconfig in App_Resources and in plugins", async () => {
-		// run merge for all release: debug|release
-		for (const release in [true, false]) {
-			await (<any>iOSProjectService).mergeProjectXcconfigFiles(projectData, { release });
+		await (<any>iOSProjectService).mergeProjectXcconfigFiles(projectData);
 
-			const destinationFilePath = xcconfigService.getPluginsXcconfigFilePath(projectRoot, { release: !!release });
+		const destinationFilePaths = xcconfigService.getPluginsXcconfigFilePaths(projectRoot);
 
-			assert.isTrue(fs.exists(destinationFilePath), 'Target build xcconfig is missing for release: ' + release);
+		_.each(destinationFilePaths, destinationFilePath => {
+			assert.isTrue(fs.exists(destinationFilePath), `Target build xcconfig ${destinationFilePath} is missing.` );
 			const content = fs.readFile(destinationFilePath).toString();
 			assert.equal(content, "");
-		}
+		});
 	});
 });