Create a `FlutterPluginUtils.kt`, and port static methods from `FlutterPlugin` there #165239

gmackall · 2025-03-14T23:36:12Z

Creates a FlutterPluginUtils.kt object to contain static methods used by the Flutter Gradle plugin, and moves over (porting them from Groovy to Kotlin)

Methods that were already static in FlutterPlugin.
Methods that were not static but were only accessing the project member. These methods were made static by changing their signature to take the project as an argument.

This doesn't get all of the methods of type 2. Specifically, I'm planning on leaving functions that interact with the Android Gradle plugin for a different PR, as this PR was getting long enough and those pieces will be a lot more brittle anyways (so I'd like to be able to revert them on their own).

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.

…eak early

…rnal logic)

packages/flutter_tools/gradle/src/main/groovy/flutter.groovy

gmackall · 2025-03-17T20:19:15Z

packages/flutter_tools/gradle/src/main/kotlin/FlutterPluginUtils.kt

+    // minimum version does support the replacement we can replace by changing a single line.
+    @JvmStatic
+    @Suppress("DEPRECATION")
+    internal fun capitalize(string: String): String = string.capitalize()


Open to removing this, I meant to actually make this the suggested replacement but we can't use the syntax because of our min version constraints.

packages/flutter_tools/gradle/src/main/groovy/flutter.groovy

packages/flutter_tools/gradle/src/main/kotlin/FlutterExtension.kt

reidbaker · 2025-03-17T20:28:16Z

packages/flutter_tools/gradle/src/main/kotlin/FlutterPluginUtils.kt

+ * A collection of static utility functions used by the Flutter Gradle Plugin.
+ */
+object FlutterPluginUtils {
+    // Gradle properties.


If these are used in other files can you add a pointer to those files? If they are used only by referencing constants can you say that in the kt doc?

Hmm intellisense should work here for finding references, so I would prefer if we instead relied on that here (it even works cross groovy boundary). Does that make sense to you?

We can talk about it in person but do think that a comment is correct. This is one of the issues with using strings. Yes tooling can find the same string in many places in code. The documentation defines where we intend the strings to match.

packages/flutter_tools/gradle/src/test/kotlin/FlutterPluginUtilsTest.kt

reidbaker · 2025-03-17T21:30:09Z

packages/flutter_tools/gradle/src/main/kotlin/FlutterPluginUtils.kt

+     * Kotlin (settings.gradle.kts). This is the same behavior as Gradle 8.5.
+     */
+    @JvmStatic
+    internal fun settingsGradleFile(project: Project): File {


On this an other methods taking in a project is a large scope/object. Consider if you can reduce what is passed in to variables that are more restricted.

For example in this method I think you can pass project.projectDir and project.logger and still have full functionality.

I think a bunch of the methods that use properties will need to stay the same here are some others I think can have reduced input scope.

buildGradleFile

shouldConfigureFlutterTask

pluginSupportsAndroidPlatform

Minimized the scope of buildGradleFile and settingsGradleFile, and changed the names.

I haven't minimized the scope of the others, because I feel like it starts to leak some of the implementation out of the methods themselves

e.g. shouldConfigureFlutterTask could take a taskNames: List<String> instead of a project, but I'm not sure it's immediately obvious to a caller that you get that list with project.gradle.startParameter.taskNames, or that whether a plugin project supports Android is a function of it's projectDir.

But can reconsider if you feel strongly that those methods should also have their scope minimized

If there is a good reason to take a project that is fine with me. Thank you for taking a pass to see if we could reduce scope.

auto-submit · 2025-03-17T23:17:12Z

autosubmit label was removed for flutter/flutter/165239, because - The status or check suite Windows framework_tests_libraries has failed. Please fix the issues identified (or deflake) before re-applying this label.

…m `FlutterPlugin` there (flutter/flutter#165239)

…erPlugin` there (flutter#165239) Creates a `FlutterPluginUtils.kt` object to contain static methods used by the Flutter Gradle plugin, and moves over (porting them from Groovy to Kotlin) 1. Methods that were already static in `FlutterPlugin`. 2. Methods that were not static but were only accessing the `project` member. These methods were made static by changing their signature to take the project as an argument. This doesn't get all of the methods of type 2. Specifically, I'm planning on leaving functions that interact with the Android Gradle plugin for a different PR, as this PR was getting long enough and those pieces will be a lot more brittle anyways (so I'd like to be able to revert them on their own). ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] 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].  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md --------- Co-authored-by: Gray Mackall <[email protected]>

Gray Mackall added 2 commits March 14, 2025 12:56

add some utils

4589cb2

wip, but I want to push to use ci to run tests for me to catch any br…

8b431b8

…eak early

github-actions bot added platform-android Android applications specifically tool Affects the "flutter" command-line tool. See also t: labels. labels Mar 14, 2025

Gray Mackall and others added 9 commits March 14, 2025 17:49

more changes, rm commented code

b39a5df

Merge branch 'master' into flutterpluginutils

7e8f80f

don't understand how to convert this yet, hold off for now

a68f302

capitalize back to capitalize

9b4fbfd

comment the comment to make ktlint happy

5848242

refactor props to consts, add tests (some of which test too much inte…

5710d3b

…rnal logic)

fix a couple warnings

7089f47

minimize the signature of the commented function

a774f34

Merge branch 'master' into flutterpluginutils

7e6f871

gmackall marked this pull request as ready for review March 17, 2025 20:03

gmackall requested review from a team and ash2moon March 17, 2025 20:03

gmackall commented Mar 17, 2025

View reviewed changes

packages/flutter_tools/gradle/src/main/groovy/flutter.groovy Outdated Show resolved Hide resolved

Gray Mackall added 2 commits March 17, 2025 13:17

rm one groovy method I forgot to delete after conversion

583937b

don't delete this in this PR

2586ae7

gmackall commented Mar 17, 2025

View reviewed changes

gmackall mentioned this pull request Mar 17, 2025

Port FlutterTask from Groovy to Kotlin #165244

Merged

9 tasks

reidbaker approved these changes Mar 17, 2025

View reviewed changes

Gray Mackall added 2 commits March 17, 2025 15:11

control jvm names with annotation, remove from usage in groovy

1187adf

minimize scope of gradle build/settings file getters

23070a6

gmackall added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 17, 2025

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

Merge branch 'master' into flutterpluginutils

eff4d44

gmackall added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 17, 2025

auto-submit bot added this pull request to the merge queue Mar 18, 2025

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

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

284d0cc

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

1526f69

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

7f77662

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

930577d

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

dbb702a

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

dea854c

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

be58f59

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 28, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

ea53e2f

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 28, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

c2b2034

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 28, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

bede58c

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 28, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

2b43b09

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 29, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

1aa0f23

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 29, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

24e1efc

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 30, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

8ab0d2f

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 30, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

180e110

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 31, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

d3c9ee7

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 31, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

e75bfe4

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 31, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

75aefaa

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 31, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

0899785

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 31, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

19ff97e

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 31, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

67ad618

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 31, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

7992de3

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

3911df8

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

6e44840

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

85f80b1

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 1, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

0d08623

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

83e5218

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

24ddd2f

…m `FlutterPlugin` there (flutter/flutter#165239)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

879d80f Create a FlutterPluginUtils.kt, and port static methods fro…

05a1270

…m `FlutterPlugin` there (flutter/flutter#165239)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Create a `FlutterPluginUtils.kt`, and port static methods from `FlutterPlugin` there #165239

Create a `FlutterPluginUtils.kt`, and port static methods from `FlutterPlugin` there #165239

Uh oh!

gmackall commented Mar 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

gmackall Mar 17, 2025

Uh oh!

Uh oh!

Uh oh!

reidbaker Mar 17, 2025

Uh oh!

gmackall Mar 17, 2025 •

edited

Loading

Uh oh!

reidbaker Mar 18, 2025

Uh oh!

Uh oh!

reidbaker Mar 17, 2025

Uh oh!

gmackall Mar 17, 2025 •

edited

Loading

Uh oh!

reidbaker Mar 18, 2025

Uh oh!

auto-submit bot commented Mar 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Create a FlutterPluginUtils.kt, and port static methods from FlutterPlugin there #165239

Create a FlutterPluginUtils.kt, and port static methods from FlutterPlugin there #165239

Uh oh!

Conversation

gmackall commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Uh oh!

gmackall Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

reidbaker Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

gmackall Mar 17, 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!

reidbaker Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

reidbaker Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

gmackall Mar 17, 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!

reidbaker Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

auto-submit bot commented Mar 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Create a `FlutterPluginUtils.kt`, and port static methods from `FlutterPlugin` there #165239

Create a `FlutterPluginUtils.kt`, and port static methods from `FlutterPlugin` there #165239

gmackall commented Mar 14, 2025 •

edited

Loading

gmackall Mar 17, 2025 •

edited

Loading

gmackall Mar 17, 2025 •

edited

Loading