Xcode 14 Support

[kwridan]

Overview

Xcode 14 beta has just been released 🎉

We can start a list of items that may be relevant to Tuist, for example:

• Any Xcodeproj format changes that warrant support in https://github.com/tuist/XcodeProj
• Any fixes needed to support generating Xcode 14 compatible projects
• Any Xcode 14 features Tuist can support or leverage

Feel free to comment if you spot anything relevant and we'll consolidate / group things.

Items

Generation

Project format changes

• Investigate any new format changes (see Xcode 13 Changes #3074 as an example)

Known changes so far:

• TEST_HOST for projects created with created with Xcode 14 differ slightly from prior versions of Xcode, but it's still compatible

- $(BUILT_PRODUCTS_DIR)/TemplateApp.app/TemplateApp
+ $(BUILT_PRODUCTS_DIR)/TemplateApp.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/TemplateApp

• Scheme stability with EnvironmentVariables

-      <EnvironmentVariables>
-      </EnvironmentVariables>

Recommended Settings

DEAD_CODE_STRIPPING = YES;

• Add DEAD_CODE_STRIPPING default project setting XcodeProj#706

Thread Performance Checker

Xcode 14 introduces a new "Thread Performance" runtime checker that is enabled by default. This can be configured in the scheme diagnostics option for the Run action (it doesn't appear under the Test action).

The scheme option only appears if explicitly disabled.

   <LaunchAction
+      disablePerformanceAntipatternChecker = "YES"
    >
   <!-- ... -->
   </LaunchAction>

• Add support for Thread Performance Checker scheme diagnostics option XcodeProj#693
• Add support for performanceAntipatternChecker SchemeDiagnosticsOptions #4740
  • RunAction and TestAction diagnostics options may need to be separated as this option isn't common to both
  • Alternatively, this could be ignored for the TestAction

App Intents Extension

There's a new product type in Xcode 14 - AppIntents extension (not to be confused with SiriKit Intents extension)

• Add support for ExtensionKit extension product types (new in Xcode 14) XcodeProj#687
• Add support for appIntentsExtension to Tuist

Background Assets Extension

There's a new product type in Xcode 14 - BackgroundAssets extension

• Add support for ExtensionKit extension product types (new in Xcode 14) XcodeProj#687
• Add support for backgroundAssetsExtension to Tuist

watchOS + extension targets

watchOS apps can now include extension such as the WidgetKit extension

• Add extension target dependency support for watchOS applications

watchOS App extensions are now merged into the watchOS App

• Project XXX - Upgrade "Watch" to single-target watch app #4572

Multiplatform Support

Xcode 14 enables a single target to support multiple platforms and conditionally include dependencies, code, resources, and build settings for specific platforms. (74664328)

• Investigate what this entails

Integrations

Swift Package Plugins

Xcode 14 supports using Swift Package plugins (e.g. adding linters, formatter, code generators).

• Investigate how package plugins can be integrated into Tuist generated projects

Dependencies.swift

Fetch fails with Xcode 14 beta

• Fetch fails on macOS 13 Ventura (Beta) with Xcode 14 (Beta) #4538

References

• Xcode 14 beta - release notes
• Some of the past year lists:
  • Xcode 13 Changes #3074
  • Xcode 12 Support #1497

[kwridan]

The first thing I spotted was

Xcode 14 enables a single target to support multiple platforms and conditionally include dependencies, code, resources, and build settings for specific platforms. (74664328)

I wonder what this entails, we can do a small spike to see what it is and if we can support or leverage it in Tuist

[rmnblm]

Hey @kwridan 👋

I guess it's about that, having a single target with both iOS and macOS platforms.

I didn't keep track with the latest versions of Tuist. Do I assume correctly that this is not possible yet?

[kwridan]

That's the one - correct, Tuist doesn't currently support multi-platform targets.

There was an attempt a while ago #397, we found a few challenges especially regarding default settings. It probably warrants a revisit now that Xcode makes this a normal option to have (whereas before it was a bit more specialised).

[fdobbie]

Opening a generated Xcode project in Xcode 14 seems to dirty the xcscheme with

-      <EnvironmentVariables>
-      </EnvironmentVariables>

[kwridan]

There's a new product type for AppIntents extension (not to be confused with SiriKit Intents extension)

• productType: com.apple.product-type.extensionkit-extension

		FB2930F2284F86D7004FAF29 /* AppIntentsExtension */ = {
			isa = PBXNativeTarget;
			buildConfigurationList = FB2930FB284F86D7004FAF29 /* Build configuration list for PBXNativeTarget "AppIntentsExtension" */;
			buildPhases = (
				FB2930EF284F86D7004FAF29 /* Sources */,
				FB2930F0284F86D7004FAF29 /* Frameworks */,
				FB2930F1284F86D7004FAF29 /* Resources */,
			);
			buildRules = (
			);
			dependencies = (
			);
			name = AppIntentsExtension;
			productName = AppIntentsExtension;
			productReference = FB2930F3284F86D7004FAF29 /* AppIntentsExtension.appex */;
			productType = "com.apple.product-type.extensionkit-extension";
		};

https://developer.apple.com/documentation/AppIntents

[Arafo]

Running tuist fetch throws this error with Xcode 14 / Swift 5.7

We received an error that we couldn't handle:
    - Localized description: The data couldn’t be read because it is missing.
    - Error: keyNotFound(CodingKeys(stringValue: "name", intValue: nil), Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "targets", intValue: nil), _JSONKey(stringValue: "Index 0", intValue: 0), CodingKeys(stringValue: "settings", intValue: nil), _JSONKey(stringValue: "Index 0", intValue: 0)], debugDescription: "No value associated with key CodingKeys(stringValue: \"name\", intValue: nil) (\"name\").", underlyingError: nil))

I've not been able to spot which dependency on my own is throwing this but it looks related to the dump-package introducing some breaking changes

[danieleformichelli]

It seems the format is changed, but can't see the changes reflected in the official repo so can't fix it right now without reverse engineering it

[mflknr]

Not sure if it's necessary at this point or even a global issue with SPM, but I got the same error when adding "FirebaseCrashlytics" as a SPM dependency to a project. Here is a sample: TuistXcode14.zip

[Arafo]

I also have FirebaseCrashlytics added and indeed, when running tuist generate after fetch has failed, tuist complains about FirebaseCrashlytics

[danieleformichelli]

Logged here

[kwridan]

There's a new extension target for Background Assets

		FBE4DE842859B1EC00C6A189 /* BackgroundExt */ = {
			isa = PBXNativeTarget;
			buildConfigurationList = FBE4DE8E2859B1EC00C6A189 /* Build configuration list for PBXNativeTarget "BackgroundExt" */;
			buildPhases = (
				FBE4DE812859B1EC00C6A189 /* Sources */,
				FBE4DE822859B1EC00C6A189 /* Frameworks */,
				FBE4DE832859B1EC00C6A189 /* Resources */,
			);
			buildRules = (
			);
			dependencies = (
			);
			name = BackgroundExt;
			productName = BackgroundExt;
			productReference = FBE4DE852859B1EC00C6A189 /* BackgroundExt.appex */;
			productType = "com.apple.product-type.extensionkit-extension";
		};

References:

• https://developer.apple.com/videos/play/wwdc2022-110403

[kwridan]

Watch apps can now have widget kit extension targets

References:

• https://developer.apple.com/videos/play/wwdc2022/10050/?time=377

[ffittschen]

One thing that would also be interesting is the support for Swift Package Plugins.

https://developer.apple.com/wwdc22/110359

As the TargetDependency.package(product:) is deprecated, we might need to think about alternatives of handling Swift Package Plugins.

Use cases in our project would be

• Running SwiftGen in a build phase with the package plugin instead of having a shell call the binary
• Running SwiftFormat when needed (Triggered by dev via context menu)

[kwridan]

Unit test with host apps have a slightly different TEST_HOST path specified in the pbxproj file:

 $(BUILT_PRODUCTS_DIR)/AppProductName.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/AppProductName

Doing an xcdiff on a the basic app templates created by Xcode 13.4 and Xcode 14 beta reveals this:

$ xcdiff -p1 Xcode13/TemplateApp.xcodeproj -p2 Xcode14/TemplateApp.xcodeproj --verbose --differences-only
# ...
❌ SETTINGS > "TemplateAppTests" target > "Debug" configuration > Values

⚠️  Value mismatch (2):

  • IPHONEOS_DEPLOYMENT_TARGET
    ◦ 15.5
    ◦ 16.0

  • TEST_HOST
    ◦ $(BUILT_PRODUCTS_DIR)/TemplateApp.app/TemplateApp
    ◦ $(BUILT_PRODUCTS_DIR)/TemplateApp.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/TemplateApp

It seems Xcode 14 beta is compatible with both.

[kwridan]

There's a new "Thread Performance Checker" scheme diagnostics option which is enabled by default:

The scheme option only appears if it's disabled:

   <LaunchAction
+      disablePerformanceAntipatternChecker = "YES"
    >
   <!-- ... -->
   </LaunchAction>

[kwridan]

Thanks to @pavm035 for reporting this! #4572

watchOS applications no longer require a watchKit extension, furthermore have a different product type.

[kwridan]

There's a new recommended setting suggested by Xcode 14

DEAD_CODE_STRIPPING = YES;

[alexanderwe]

I am not sure if I made a mistake somewhere but I still see this warning when generating my project with Xcode 13.4.1 and then open it in Xcode 14 I still see the DEAD_CODE_STRIPPING recommendation for my project opened in Xcode 14 Beta 3

Edit: - Or do you think this happens because my Target supports "Mac (Designed for iPad)" ?

[kwridan]

Or do you think this happens because my Target supports "Mac (Designed for iPad)" ?

Ah that's probably it.

You can add the setting to your target in the project manifest address this.

[kwridan]

In Tuist we'll need to either blindly add it to all targets iOS / macOS as a default recommended setting, or conditionally add it for iOS if catalyst support is declared.

[kwridan]

Pushed tuist/XcodeProj#706 to add to projects default settings

[alexanderwe]

Thank you for taking care of it :)

[lordcodes]

From above:

Swift Package Plugins

Xcode 14 supports using Swift Package plugins (e.g. adding linters, formatter, code generators).

Investigate how package plugins can be integrated into Tuist generated projects

As far as I can tell the SPM package plugins just needed to be specified as an SPM package dependency (without any products added to any targets) and SPM/Xcode will detect plugins within them and allow them to be used.
Currently, Tuist flags SPM package dependencies specified via 'Project' as deprecated and to use Dependencies.swift. However, I guess for SPM plugins you would want them to just be added to project rather than via Dependencies.swift. Tuist could un-deprecate specifying SPM dependencies that way, as it is the default way to do it with Xcode anyway.

[MarcoEidinger]

Required for build tool plugins to be executed on Xcode projects => plugin needs to be specified in "Build Phases" of Xcode target editor

/* Begin PBXTargetDependency section */
		19FEA9CA289DE8DF00DA8314 /* PBXTargetDependency */ = {
			isa = PBXTargetDependency;
			productRef = 19FEA9C9289DE8DF00DA8314 /* RevealBuildPlugin */;
		};
/* End PBXTargetDependency section */

[danieleformichelli]

In Xcode 14 I get a warning for build phases without specified outputs:

warning build: Run script build phase 'SwiftLint' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase.

We should probably automatically uncheck Based on dependency analysis when configuring a build phase in tuist without output files

[EthanLipnik]

Is there any update on the multi platform support? It's preventing me from using Tuist in most side projects