![]() This PR adds initial support for Swift Package Manager (SPM). Users must opt in. Only compatible with Xcode 15+. Fixes https://github.com/flutter/flutter/issues/146369. ## Included Features This PR includes the following features: * Enabling SPM via config `flutter config --enable-swift-package-manager` * Disabling SPM via config (will disable for all projects) `flutter config --no-enable-swift-package-manager` * Disabling SPM via pubspec.yaml (will disable for the specific project) ``` flutter: disable-swift-package-manager: true ``` * Migrating existing apps to add SPM integration if using a Flutter plugin with a Package.swift * Generates a Swift Package (named `FlutterGeneratedPluginSwiftPackage`) that handles Flutter SPM-compatible plugin dependencies. Generated package is added to the Xcode project. * Error parsing of common errors that may occur due to using CocoaPods and Swift Package Manager together * Tool will print warnings when using all Swift Package plugins and encourage you to remove CocoaPods This PR also converts `integration_test` and `integration_test_macos` plugins to be both Swift Packages and CocoaPod Pods. ## How it Works The Flutter CLI will generate a Swift Package called `FlutterGeneratedPluginSwiftPackage`, which will have local dependencies on all Swift Package compatible Flutter plugins. The `FlutterGeneratedPluginSwiftPackage` package will be added to the Xcode project via altering of the `project.pbxproj`. In addition, a "Pre-action" script will be added via altering of the `Runner.xcscheme`. This script will invoke the flutter tool to copy the Flutter/FlutterMacOS framework to the `BUILT_PRODUCTS_DIR` directory before the build starts. This is needed because plugins need to be linked to the Flutter framework and fortunately Swift Package Manager automatically uses `BUILT_PRODUCTS_DIR` as a framework search path. CocoaPods will continue to run and be used to support non-Swift Package compatible Flutter plugins. ## Not Included Features It does not include the following (will be added in future PRs): * Create plugin template * Create app template * Add-to-App integration |
||
---|---|---|
.. | ||
debug_adapter | ||
isolated | ||
test_data | ||
analyze_all_templates_test.dart | ||
analyze_once_test.dart | ||
analyze_size_test.dart | ||
analyze_suggestions_integration_test.dart | ||
android_e2e_api_test.dart | ||
android_gradle_daemon_cache_test.dart | ||
android_gradle_deprecated_plugin_apply_test.dart | ||
android_gradle_flutter_source_path_test.dart | ||
android_gradle_java_version_test.dart | ||
android_gradle_outputs_app_link_settings_test.dart | ||
android_gradle_print_build_variants_test.dart | ||
android_plugin_compilesdkversion_mismatch_test.dart | ||
android_plugin_example_app_build_test.dart | ||
android_plugin_ndkversion_mismatch_test.dart | ||
android_plugin_new_output_dir_test.dart | ||
android_plugin_skip_unsupported_test.dart | ||
background_isolate_test.dart | ||
bash_entrypoint_test.dart | ||
batch_entrypoint_test.dart | ||
break_on_framework_exceptions_test.dart | ||
build_ios_config_only_test.dart | ||
build_macos_config_only_test.dart | ||
build_preview_test.dart | ||
cache_test.dart | ||
command_output_test.dart | ||
coverage_collection_test.dart | ||
daemon_mode_test.dart | ||
debugger_stepping_test.dart | ||
deferred_components_test.dart | ||
deprecated_gradle_settings_test.dart | ||
devtools_uri_test.dart | ||
downgrade_upgrade_integration_test.dart | ||
exit_code_test.dart | ||
expression_evaluation_test.dart | ||
flutter_attach_test.dart | ||
flutter_build_android_app_project_builddir_test.dart | ||
flutter_build_apk_verbose_test.dart | ||
flutter_build_config_only_test.dart | ||
flutter_build_wasm_test.dart | ||
flutter_build_windows_test.dart | ||
flutter_build_with_compilation_error_test.dart | ||
flutter_gen_test.dart | ||
flutter_run_test.dart | ||
flutter_run_with_error_test.dart | ||
forbidden_imports_test.dart | ||
gen_l10n_test.dart | ||
gradle_non_android_plugin_test.dart | ||
hot_reload_errors_test.dart | ||
hot_reload_test.dart | ||
hot_reload_with_asset_test.dart | ||
lifetime_test.dart | ||
observatory_port_test.dart | ||
overall_experience_test.dart | ||
plist_parser_test.dart | ||
README.md | ||
shader_compiler_test.dart | ||
stateless_stateful_hot_reload_test.dart | ||
swift_package_manager_test.dart | ||
template_manifest_test.dart | ||
test_driver.dart | ||
test_test.dart | ||
test_utils.dart | ||
timeline_test.dart | ||
tool_backend_test.dart | ||
transition_test_utils.dart | ||
unit_coverage_test.dart | ||
variable_expansion_windows_test.dart | ||
variable_expansion_windows.dart | ||
vmservice_integration_test.dart | ||
web_plugin_registrant_test.dart | ||
xcode_backend_test.dart |
Integration tests
These tests are not hermetic, and use the actual Flutter SDK. While
they don't require actual devices, they run flutter_tester
to test
Dart VM and Flutter integration.
Use this command to run (from the flutter_tools
directory):
../../bin/cache/dart-sdk/bin/dart run test test/integration.shard
You need to have downloaded the Dart SDK in your Flutter clone for this
to work. Running ../../bin/flutter
will automatically download it.
Coverage exclusion
These tests are expensive to run and do not give meaningful coverage
information for the flutter
tool (since they are black-box tests that
run the tool as a subprocess, rather than being unit tests). For this
reason, they are in a separate shard when running on continuous
integration and are not run when calculating coverage.
Adding new test files
When adding a new test file make sure that it ends with _test.dart
, or else it will not be run.