[tool] Use `swift-format` from Xcode #9460

stuartmorgan-g · 2025-06-20T14:29:32Z

As of Xcode 16, swift-format is part of the Xcode distribution. Since CI now uses Xcode 16, we can just always use that version.

This:

Removes the swift-format-path logic.
Removes the check for swift-format being available
Defaults Swift formatting to true only on macOS
Removes the swift-format CIPD package from .ci.yaml
Updates Pigeon in packages using Swift Pigeon generation to pick up a fix for a lint issue picked up by the latest version of swift-format (which was already fixed in Pigeon).

Fixes flutter/flutter#153803

Pre-Review Checklist

Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩² ↩³

stuartmorgan-g · 2025-06-20T14:32:20Z

@jmagman / @vashworth Any objection to this approach of just unconditionally using xcrun, rather than using the multi-step check originally described in flutter/flutter#153803 ?

We could still do that version, if we wanted to support overriding the swift-format version (or to allow running swift-format from other platforms), but in practice I think that now that it's part of Xcode the chances that anyone will ever actually want to run a version that's not the Xcode version is very low, so probably not worth the complexity in the tool.

stuartmorgan-g · 2025-06-20T14:40:38Z

packages/file_selector/file_selector_macos/pigeons/messages.dart

 /// Options for open panels.
 ///
 /// These correspond to NSOpenPanel properties.
-class OpenPanelOptions extends SavePanelOptions {


This change preserves the old behavior. When I first wrote this I used inheritance out of habit, but that didn't actually do anything in Pigeon at the time. I fixed it by adding composition (line 62 below), but forgot to remove this extends that was being ignored.

In the current Pigeon this is an error, because inheritance does work, but only to inherit from a sealed empty base class to allow type switching.

cbracken

cbracken · 2025-06-23T15:07:57Z

script/tool/lib/src/format_command.dart

    argParser.addFlag(_javaArg, help: 'Format Java files', defaultsTo: true);
    argParser.addFlag(_swiftArg,
-        help: 'Format and lint Swift files', defaultsTo: true);
+        help: 'Format and lint Swift files', defaultsTo: platform.isMacOS);


fyi: Nothing to do for this patch, but it looks like swift-format is open source https://github.com/swiftlang/swift-format and tagged for various releases if we one did want to support this on Linux as well.

vashworth · 2025-06-23T15:18:36Z

@jmagman / @vashworth Any objection to this approach of just unconditionally using xcrun, rather than using the multi-step check originally described in flutter/flutter#153803 ?

We could still do that version, if we wanted to support overriding the swift-format version (or to allow running swift-format from other platforms), but in practice I think that now that it's part of Xcode the chances that anyone will ever actually want to run a version that's not the Xcode version is very low, so probably not worth the complexity in the tool.

No objection. We should document how to add this back somewhere in case we do want to use it again.

vashworth

LGTM

stuartmorgan-g · 2025-06-23T15:23:32Z

We should document how to add this back somewhere in case we do want to use it again.

I'll add a comment with some context and a link to this PR on the constructor line that makes it default to on for macOS only.

stuartmorgan-g · 2025-06-23T15:24:48Z

CHANGELOG/version override: webview_flutter_wkwebview change is whitespace-only.

auto-submit · 2025-06-23T15:56:06Z

autosubmit label was removed for flutter/packages/9460, because - The status or check suite Linux_android android_device_tests_shard_1 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2025-06-23T17:25:56Z

autosubmit label was removed for flutter/packages/9460, because - The status or check suite Linux_android android_platform_tests_shard_1 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2025-06-23T18:13:09Z

autosubmit label was removed for flutter/packages/9460, because - The status or check suite Linux_android android_platform_tests_shard_1 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

jmagman

Thank you!

flutter/packages@5963ecd...2c8d2bc 2025-06-26 [email protected] Bump AVD and SDK to API 36 in Packages CI (flutter/packages#9414) 2025-06-26 [email protected] [tool] Use `swift-format` from Xcode (flutter/packages#9460) 2025-06-26 [email protected] Revert "[camera_android_camerax] Force new `Surface` for each `SurfaceRequest`" (flutter/packages#9500) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

As of Xcode 16, `swift-format` is part of the Xcode distribution. Since CI now uses Xcode 16, we can just always use that version. This: - Removes the `swift-format-path` logic. - Removes the check for `swift-format` being available - Defaults Swift formatting to true only on macOS - Removes the `swift-format` CIPD package from .ci.yaml - Updates Pigeon in packages using Swift Pigeon generation to pick up a fix for a lint issue picked up by the latest version of `swift-format` (which was already fixed in Pigeon). Fixes flutter/flutter#153803 ## Pre-Review Checklist [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.

flutter/packages@5963ecd...2c8d2bc 2025-06-26 [email protected] Bump AVD and SDK to API 36 in Packages CI (flutter/packages#9414) 2025-06-26 [email protected] [tool] Use `swift-format` from Xcode (flutter/packages#9460) 2025-06-26 [email protected] Revert "[camera_android_camerax] Force new `Surface` for each `SurfaceRequest`" (flutter/packages#9500) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

stuartmorgan-g added 5 commits June 20, 2025 10:07

Use swift-format from Xcode

4e6a636

Update formatting

a06c5a7

Update Pigeon for warnings

283a320

Version bumps

0425fec

Remove swift_format from .ci.yaml

cceba0c

stuartmorgan-g requested review from LongCatIsLooong, LouiseHsu, cbracken, hellohuanlin and vashworth as code owners June 20, 2025 14:29

github-actions bot added p: file_selector p: path_provider p: quick_actions platform-ios platform-macos p: webview_flutter p: url_launcher labels Jun 20, 2025

stuartmorgan-g commented Jun 20, 2025

View reviewed changes

Update test for Pigeon changes

da43ca6

cbracken approved these changes Jun 23, 2025

View reviewed changes

vashworth approved these changes Jun 23, 2025

View reviewed changes

stuartmorgan-g added override: no versioning needed Override the check requiring version bumps for most changes override: no changelog needed Override the check requiring CHANGELOG updates for most changes labels Jun 23, 2025

Add a comment with a breadcrumb to multi-OS support

e0834a4

stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 23, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jun 23, 2025

stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 23, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jun 23, 2025

stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 23, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jun 23, 2025

stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 24, 2025

stuartmorgan-g mentioned this pull request Jun 24, 2025

[format_command] - fixed fallback logic within formatter command class #9410

Closed

11 tasks

jmagman approved these changes Jun 24, 2025

View reviewed changes

auto-submit bot merged commit 111ceb7 into flutter:main Jun 26, 2025
79 checks passed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 26, 2025

111ceb7 [tool] Use swift-format from Xcode (flutter/packages#9460)

bb93323

engine-flutter-autoroll mentioned this pull request Jun 26, 2025

Roll Packages from 5963ecdb2dbc to 2c8d2bc0589c (3 revisions) flutter/flutter#171227

Merged

jmagman mentioned this pull request Jul 25, 2025

Format and lint Swift files with swift-format flutter/flutter#172799

Open

stuartmorgan-g mentioned this pull request Jul 26, 2025

[camera_avfoundation] Implementation swift migration - part 10 #9664

Merged

11 tasks

jmagman mentioned this pull request Aug 1, 2025

[webview_flutter_wkwebview] Swift formatting incorrect with Xcode 26 beta 4 flutter/flutter#172983

Open

[tool] Use swift-format from Xcode #9460

[tool] Use swift-format from Xcode #9460

Uh oh!

Conversation

stuartmorgan-g commented Jun 20, 2025

Pre-Review Checklist

Footnotes

Uh oh!

stuartmorgan-g commented Jun 20, 2025

Uh oh!

stuartmorgan-g Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cbracken left a comment

Choose a reason for hiding this comment

Uh oh!

cbracken Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

vashworth commented Jun 23, 2025

Uh oh!

vashworth left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g commented Jun 23, 2025

Uh oh!

stuartmorgan-g commented Jun 23, 2025

Uh oh!

auto-submit bot commented Jun 23, 2025

Uh oh!

auto-submit bot commented Jun 23, 2025

Uh oh!

auto-submit bot commented Jun 23, 2025

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[tool] Use `swift-format` from Xcode #9460

[tool] Use `swift-format` from Xcode #9460

stuartmorgan-g Jun 20, 2025 •

edited

Loading