mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
0ff9e8a928
We decided that redefining the default for templates was premature. We're going to go back to having "module" in experimental land again, and we'll try again when we have the feature set fully baked. This keeps the writing of the .metadata files, and writing the template type to them, because that was a good improvement, and there are still a bunch of added tests that improve our coverage.
88 lines
2.2 KiB
Markdown
88 lines
2.2 KiB
Markdown
# 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.
|