Add Flutter as a Swift Package dependency #178931

vashworth · 2025-11-21T17:09:49Z

The main purpose of this PR is to add the Flutter framework as a Swift Package dependency. As such, Xcode will now handle the copying, thinning, and codesigning of the framework and therefore the Flutter Xcode Run Scripts shouldn't.

This will allow plugins to declare a dependency on the Flutter framework package and eliminate the need for the Pre-Action "prepare" script.

This PR does not technically make the Flutter framework a local package override, that will be added in a follow up PR: #179512

This change includes:

Generation of the FlutterFramework swift package (this will generate a Package.swift and symlink to the Flutter framework in the artifact cache)
Adding the FlutterFramework as a dependency to the FlutterGeneratedPluginSwiftPackage (which the the Swift package the Xcode project has a dependency on)

Change to Flutter Run Scripts

Flutter currently has 3 Xcode Run Scripts:

prepare (happens in a scheme pre-action)
- [PREVIOUS] Via flutter assemble - copies the Flutter framework from engine build cache to BUILT_PRODUCTS_DIR
- [NEW] Same as previous except skips codesigning. This is still included to accommodate plugins that don't have a dependency declared on the Flutter framework.
build (happens in first Run Script in the Xcode build phases that happens before compiling)
- [PREVIOUS] Via flutter assemble - copies, thins, and codesigns Flutter framework into BUILT_PRODUCTS_DIR
- [NEW] Is skipped, Xcode now does this
embed_and_thin (happens in second Run Script in the Xcode build phases after compiling, linking, and embedding)
- [PREVIOUS] Copies Flutter framework from BUILT_PRODUCTS_DIR to TARGET_BUILD_DIR
- [NEW]
  - Validates Flutter framework in BUILT_PRODUCTS_DIR & TARGET_BUILD_DIR (which would have been put there by Xcode via SwiftPM) matches the Flutter framework in the engine cache.
  - If it matches, do not copy. Xcode now does this.
  - If it doesn't:
    - Call flutter assemble to copy the correct Flutter framework into BUILT_PRODUCTS_DIR
    - Then copy from BUILT_PRODUCTS_DIR to TARGET_BUILD_DIR.

Fixes #166489.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

…er_dependency

vashworth · 2025-12-05T19:28:38Z

packages/flutter_tools/bin/xcode_backend.dart

+        final String? sdkRoot = environment['SDKROOT']?.toLowerCase();
+        if (sdkRoot == null || !sdkRoot.contains('iphone')) {
+          return null;
+        }
+        final bool simulatorSDK = sdkRoot.contains('simulator');


This is mimicking:

flutter/packages/flutter_tools/lib/src/macos/xcode.dart

Lines 285 to 293 in f63cf73

EnvironmentType? environmentTypeFromSdkroot(String sdkroot, FileSystem fileSystem) {

// iPhoneSimulator.sdk or iPhoneOS.sdk

final String sdkName = fileSystem.path.basename(sdkroot).toLowerCase();

if (sdkName.contains('iphone')) {

return sdkName.contains('simulator') ? EnvironmentType.simulator : EnvironmentType.physical;

}

assert(false);

return null;

}

vashworth · 2025-12-05T19:29:12Z

packages/flutter_tools/bin/xcode_backend.dart

+        for (final FileSystemEntity entity in xcframework.listSync()) {
+          final String platformBaseName = Uri.parse(entity.path).pathSegments.last;
+          if (entity is Directory && platformBaseName.startsWith('ios-')) {
+            final bool isSimulatorDirectory = platformBaseName.endsWith('-simulator');
+            if (simulatorSDK == isSimulatorDirectory) {
+              return File('${entity.path}/${platform.infoPlistPath}');
+            }
+          }
+        }


This is mimicking:

flutter/packages/flutter_tools/lib/src/artifacts.dart

Lines 954 to 966 in f63cf73

for (final Directory platformDirectory

in xcframeworkDirectory.listSync().whereType<Directory>()) {

if (!platformDirectory.basename.startsWith('ios-')) {

continue;

}

// ios-x86_64-simulator, ios-arm64_x86_64-simulator, or ios-arm64.

final bool simulatorDirectory = platformDirectory.basename.endsWith('-simulator');

if ((environmentType == EnvironmentType.simulator && simulatorDirectory) ||

(environmentType == EnvironmentType.physical && !simulatorDirectory)) {

return platformDirectory;

}

}

throwToolExit('No iOS frameworks found in ${xcframeworkDirectory.path}');

vashworth · 2025-12-05T19:29:41Z

packages/flutter_tools/bin/xcode_backend.dart

+        for (final FileSystemEntity entity in xcframework.listSync()) {
+          final String platformBaseName = Uri.parse(entity.path).pathSegments.last;
+          if (entity is Directory && platformBaseName.startsWith('macos-')) {
+            return File('${entity.path}/${platform.infoPlistPath}');
+          }
+        }


This is mimicking:

flutter/packages/flutter_tools/lib/src/artifacts.dart

Lines 1026 to 1033 in f63cf73

final Directory? platformDirectory = xcframeworkDirectory

.listSync()

.whereType<Directory>()

.where((Directory platformDirectory) => platformDirectory.basename.startsWith('macos-'))

.firstOrNull;

if (platformDirectory == null) {

throwToolExit('No macOS frameworks found in ${xcframeworkDirectory.path}');

}

stuartmorgan-g

Minor comments, but LGTM. The large caveat is that I have limited familiarity with this part of the code, so am unlikely to notice subtle implementation mistakes, but the structure makes sense to me and matches my understanding of the design doc, and the tests look thorough.

packages/flutter_tools/bin/xcode_backend.dart

packages/flutter_tools/lib/src/build_info.dart

packages/flutter_tools/test/general.shard/xcode_backend_test.dart

Add Flutter as a Swift Package dependency

46366e5

vashworth and others added 5 commits November 21, 2025 14:55

fix tests

cde7a2a

++

6d47031

++

38bbd73

Merge remote-tracking branch 'upstream/main' into swiftpm_local_flutt…

b71b75e

…er_dependency

Merge branch 'master' into swiftpm_local_flutter_dependency

4258f2b

vashworth commented Dec 5, 2025

View reviewed changes

vashworth marked this pull request as ready for review December 5, 2025 19:31

vashworth requested a review from a team as a code owner December 5, 2025 19:31

vashworth requested a review from stuartmorgan-g December 5, 2025 19:31

stuartmorgan-g approved these changes Dec 10, 2025

View reviewed changes

renaming, clean up, better logs

776faa7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Flutter as a Swift Package dependency #178931

Add Flutter as a Swift Package dependency #178931

Uh oh!

vashworth commented Nov 21, 2025 •

edited

Loading

Uh oh!

vashworth Dec 5, 2025

Uh oh!

vashworth Dec 5, 2025

Uh oh!

vashworth Dec 5, 2025

Uh oh!

stuartmorgan-g left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	EnvironmentType? environmentTypeFromSdkroot(String sdkroot, FileSystem fileSystem) {
	// iPhoneSimulator.sdk or iPhoneOS.sdk
	final String sdkName = fileSystem.path.basename(sdkroot).toLowerCase();
	if (sdkName.contains('iphone')) {
	return sdkName.contains('simulator') ? EnvironmentType.simulator : EnvironmentType.physical;
	}
	assert(false);
	return null;
	}

	for (final Directory platformDirectory
	in xcframeworkDirectory.listSync().whereType<Directory>()) {
	if (!platformDirectory.basename.startsWith('ios-')) {
	continue;
	}
	// ios-x86_64-simulator, ios-arm64_x86_64-simulator, or ios-arm64.
	final bool simulatorDirectory = platformDirectory.basename.endsWith('-simulator');
	if ((environmentType == EnvironmentType.simulator && simulatorDirectory) \|\|
	(environmentType == EnvironmentType.physical && !simulatorDirectory)) {
	return platformDirectory;
	}
	}
	throwToolExit('No iOS frameworks found in ${xcframeworkDirectory.path}');

	final Directory? platformDirectory = xcframeworkDirectory
	.listSync()
	.whereType<Directory>()
	.where((Directory platformDirectory) => platformDirectory.basename.startsWith('macos-'))
	.firstOrNull;
	if (platformDirectory == null) {
	throwToolExit('No macOS frameworks found in ${xcframeworkDirectory.path}');
	}

Add Flutter as a Swift Package dependency #178931

Are you sure you want to change the base?

Add Flutter as a Swift Package dependency #178931

Uh oh!

Conversation

vashworth commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change to Flutter Run Scripts

Pre-launch Checklist

Uh oh!

vashworth Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

vashworth Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

vashworth Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vashworth commented Nov 21, 2025 •

edited

Loading