Gray Mackall d1d9954c45
Support host android apps with kts gradle files for add to app (#156502)
Allows applying of `include_flutter.groovy` via the `apply from:` syntax, which allows using a host app that is using the Gradle Kotlin DSL (the default these days when creating an Android app in AS).

Explanation: The `include_flutter.groovy` script is currently not able to be called by Kotlin gradle files, because it is [intended to be invoked with the following lines](https://docs.flutter.dev/add-to-app/android/project-setup#depend-on-the-modules-source-code):
```
setBinding(new Binding([gradle: this]))                                // new
evaluate(new File(                                                     // new
    settingsDir.parentFile,                                            // new
    'flutter_module/.android/include_flutter.groovy'                   // new
))
```

`setBinding` isn't part of the Kotlin gradle DSL, and there isn't (that I can find) an easy Kotlin equivalent. If this binding isn't set, the reference to `gradle` in `include_flutter.groovy` is wrong, which breaks the script.

This PR modifies `include_flutter.groovy` to also support being invoked through the standard way of invoking a script via the Gradle Groovy/Kotlin DSLs, which is `apply from:` (or it's slightly different Kotlin syntax). The start of the script identifies which of the two approaches is being used by checking if the binding is set, and then initializes some variables differently depending on the case.

If we land this, I believe we should update the example Gradle files for both the `kts` and `groovy` cases to prefer the `apply from` syntax as I think this is the syntax most developers would be more familiar with already seeing in their Gradle files.
2024-10-16 22:47:27 +00:00
..

Templates for Flutter Module

common

Written to root of Flutter application.

Adds Dart project files including pubspec.yaml.

android

library

Written to the .android/ hidden folder.

Contents wraps Flutter/Dart code as a Gradle project that defines an Android library.

Executing ./gradlew flutter:assembleDebug in that folder produces a .aar archive.

Android host apps can set up a dependency to this project to consume Flutter views.

gradle

Written to .android/ or android/.

Mixin for adding Gradle boilerplate to Android projects.

host_app_common

Written to either .android/ or android/.

Contents define a single-Activity, single-View Android host app with a dependency on the .android/Flutter library.

Executing ./gradlew app:assembleDebug in the target folder produces an .apk archive.

Used with either android_host_ephemeral or android_host_editable.

host_app_ephemeral

Written to .android/ on top of android_host_common.

Combined contents define an ephemeral (hidden, auto-generated, under Flutter tooling control) Android host app with a dependency on the .android/Flutter library.

host_app_editable

Written to android/ on top of android_host_common.

Combined contents define an editable (visible, one-time generated, under app author control) Android host app with a dependency on the .android/Flutter library.

ios

library

Written to the .ios/Flutter hidden folder.

Contents wraps Flutter/Dart code for consumption by an Xcode project.

iOS host apps can set up a dependency to this contents to consume Flutter views.

host_app_ephemeral

Written to .ios/ outside the Flutter/ sub-folder.

Combined contents define an ephemeral (hidden, auto-generated, under Flutter tooling control) iOS host app with a dependency on the .ios/Flutter folder contents.

The host app does not make use of CocoaPods, and is therefore suitable only when the Flutter part declares no plugin dependencies.

host_app_ephemeral_cocoapods

Written to .ios/ on top of host_app_ephemeral.

Adds CocoaPods support.

Combined contents define an ephemeral host app suitable for when the Flutter part declares plugin dependencies.