Skip to content

[ci] Add flags to formatter command to decide which formatters to run #5905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 18, 2024

Conversation

jmagman
Copy link
Member

@jmagman jmagman commented Jan 16, 2024

Get ready for a world where swift-format is available on the PATH https://flutter-review.googlesource.com/c/recipes/+/54020

  1. Add format --clang-format --java --kotlin --swift --dart flags to decide whether to run specific formatters, as opposed to using the path. Keep swift-format optional but default the others to run. This matches the current behavior on Linux.
  2. Add *-path variants of each.

This will allow us to run format --swift --no-clang-format --no-java --no-kotlin --no-dart on the macOS bot so it doesn't duplicate same format call run on Linux.

Part of flutter/flutter#41129

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 relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • 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.
  • All existing and new tests are passing.

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

@jmagman jmagman self-assigned this Jan 16, 2024
@jmagman jmagman marked this pull request as ready for review January 16, 2024 23:56
@jmagman jmagman marked this pull request as draft January 17, 2024 06:51
final String? swiftFormat = getNullableStringArg(_swiftFormatArg);
if (swiftFormat != null) {
await _formatSwift(swiftFormat, files);
if (getBoolArg(_dartArg)) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forgot to add tests for these flags.

@jmagman jmagman marked this pull request as ready for review January 17, 2024 20:54
Copy link
Contributor

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jmagman jmagman added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 18, 2024
@auto-submit auto-submit bot merged commit 8ab9b25 into flutter:main Jan 18, 2024
@jmagman jmagman deleted the swift-format-flag branch January 18, 2024 16:02
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 19, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Jan 19, 2024
flutter/packages@83c2c4d...129e08c

2024-01-19 [email protected] [pigeon] Run swift-format on ungenerated example app Swift files (flutter/packages#5934)
2024-01-19 [email protected] [path_provider_foundation] Run swift-format on Swift files (flutter/packages#5935)
2024-01-19 [email protected] [shared_preferences_foundation] Run swift-format on Swift files (flutter/packages#5933)
2024-01-19 [email protected] [various] Run swift-format on example app Swift files (flutter/packages#5931)
2024-01-19 [email protected] [camera_avfoundation] Remove development team from Xcode example app (flutter/packages#5930)
2024-01-18 [email protected] [webview_flutter_wkwebview] Add javascript panel interface for wkwebview (flutter/packages#5795)
2024-01-18 [email protected] [two_dimensional_scrollables] Fix must_call_super (flutter/packages#5921)
2024-01-18 [email protected] [pointer_interceptor] fix width and height unset warning on web platform (flutter/packages#5864)
2024-01-18 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.23.0 to 3.23.1 (flutter/packages#5922)
2024-01-18 [email protected] [google_maps_flutter] Clean up iOS example project (flutter/packages#5925)
2024-01-18 [email protected] [ci] Add flags to formatter command to decide which formatters to run (flutter/packages#5905)
2024-01-18 [email protected] Update tests to Xcode 15 and iOS 17 simulator (flutter/packages#5914)
2024-01-18 [email protected] Roll Flutter from def6af0 to f77f824 (25 revisions) (flutter/packages#5924)

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],[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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants