flutter/packages/flutter_tools/gradle
Matan Lurey 5f99c893b3
Remove handling of the legacy .flutter-plugins file in PluginHandler.kt. (#169317)
As of https://github.com/flutter/flutter/pull/169283 it's impossible for
the `.flutter-plugins` file to exist outside of unit tests.
2025-05-23 17:02:02 +00:00
..
src Remove handling of the legacy .flutter-plugins file in PluginHandler.kt. (#169317) 2025-05-23 17:02:02 +00:00
.dartignore License update (#45373) 2019-11-27 15:04:02 -08:00
.gitignore Add instructions to download the Gradle wrapper to FGP readme, and add to gitignore (#162332) 2025-01-29 02:04:50 +00:00
aar_init_script.gradle Start using bin/cache/engine.{stamp|realm} instead of bin/internal/engine.{realm|version}. (#164352) 2025-03-02 00:54:33 +00:00
app_plugin_loader.gradle Remove support for imperative apply of Flutter Gradle Plugin (#160947) 2025-01-07 21:51:59 +00:00
build.gradle.kts Bumping framework Template Defaults to Android 16 (API 36) (#166464) 2025-05-05 23:46:34 +00:00
flutter_proguard_rules.pro Remove allowoptimization modifier from FlutterPlugin proguard rules (#154715) 2024-09-06 20:37:23 +00:00
flutter.gradle Remove support for imperative apply of Flutter Gradle Plugin (#160947) 2025-01-07 21:51:59 +00:00
manual_migration_settings.gradle.md Don't import plugins that don't support android in settings.gradle (#54407) 2020-04-12 08:55:03 -07:00
module_plugin_loader.gradle Convert AppPluginLoaderPlugin to Kotlin, and add NativePluginLoaderReflectionBridge to expose it in Kotlin (#166027) 2025-04-02 20:29:13 +00:00
README.md Convert dependency version checker to Kotlin source (#162771) 2025-02-12 19:42:38 +00:00
resolve_dependencies.gradle.kts Update ktlint to 1.5 (#164409) 2025-03-03 19:39:23 +00:00
settings_aar.gradle.tmpl Flutter build aar (#36732) 2019-07-23 09:27:42 -07:00
settings.gradle.kts Format all kotlin according to ktlint (#143390) 2024-02-14 17:58:18 +00:00

The Flutter Gradle Plugin

This directory contains Gradle code used to by the Flutter tool to build Flutter apps for Android, primarily the Flutter Gradle Plugin (FGP) - a Gradle plugin built on top of Gradle and the Android Gradle Plugin (AGP).

Editing in Android Studio

To get code completion in Android Studio, you must open a new Android Studio window with this directory as the root. Code completion will not work when navigating to files in an Android Studio window opened at the root of the entire Flutter repo.

Contributing

The Flutter Gradle Plugin is currently being re-written from Groovy to Kotlin (Kotlin source specifically, i.e. not .kts). As such, outside of critical bug fixes, new contributions will only be accepted in src/main/kotlin (and src/test/kotlin).

Testing

To run the tests from the CLI, you first need to download the Gradle wrapper.

  1. Ensure you have run gclient sync recently (i.e., from the root of your framework checkout, run gclient sync -D).
  2. From this directory, run ../../../engine/src/flutter/third_party/gradle/bin/gradle wrapper.

Tests can be run in Android Studio, or directly with Gradle: ./gradlew test (note that this directory does not contain a version controlled Gradle file. You can find one in the engines third_party directory at <flutter_root>/engine/src/flutter/third_party/gradle/bin/gradle).

Alternatively, you can run all the tests in one file by passing in the fully qualified class name, e.g. ./gradlew test --tests com.flutter.gradle.BaseApplicationNameHandlerTest, or one test in one file by passing in the fully qualified class name followed by the method name, e.g ./gradlew test --tests "com.flutter.gradle.BaseApplicationNameHandlerTest.setBaseName respects Flutter tool property".

Sometimes changing a test name and then running it will cause an IDE error. To get Android Studio back to a good state on Mac, run Help > "Repair IDE", and then in the popup window "Rescan project indexes > Everything works now."

To add a new test, add a class under src/test/kotlin, with methods annotated with @Test. These tests will get automatically run on CI by packages/flutter_tools/test/integration.shard/android_run_flutter_gradle_plugin_tests_test.dart.