Add The Ability To Generate Plugins From The CLI Tool

.fvmrc

@@ -0,0 +1,4 @@
+{
+  "flutter": "3.22.0",
+  "flavors": {}
+}

.github/workflows/ci.yaml

@@ -242,6 +242,7 @@ jobs:
         package:
           - frb_example--flutter_via_create
           - frb_example--flutter_via_integrate
+          - frb_example--flutter_package
 
     steps:
       # setup

.gitignore

@@ -8,8 +8,10 @@ launch.json
 Makefile
 *.log
 .vscode
-.fvm/flutter_sdk
 coverage/
 lcov.info
 temp.txt
-frb_example/my_app
+frb_example/my_app
+
+# FVM Version Cache
+.fvm/

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "frb_codegen/assets/integration_template/cargokit"]
-	path = frb_codegen/assets/integration_template/rust_builder/cargokit
+[submodule "frb_codegen/assets/integration_template/shared/rust_builder/cargokit"]
+	path = frb_codegen/assets/integration_template/shared/rust_builder/cargokit
 	url = https://github.com/irondash/cargokit

frb_codegen/assets/integration_template/plugin/example/integration_test/simple_test.dart

@@ -0,0 +1,11 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:REPLACE_ME_DART_PACKAGE_NAME/REPLACE_ME_DART_PACKAGE_NAME.dart';
+import 'package:integration_test/integration_test.dart';
+
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  setUpAll(() async => await RustLib.init());
+  test('Can call rust function', () async {
+    expect(greet(name: "Tom"), "Hello, Tom!");
+  });
+}

frb_codegen/assets/integration_template/plugin/example/lib/main.dart

@@ -0,0 +1,24 @@
+import 'package:flutter/material.dart';
+import 'package:REPLACE_ME_DART_PACKAGE_NAME/REPLACE_ME_DART_PACKAGE_NAME.dart';
+
+Future<void> main() async {
+  await RustLib.init();
+  runApp(const MyApp());
+}
+
+class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      home: Scaffold(
+        appBar: AppBar(title: const Text('flutter_rust_bridge quickstart')),
+        body: Center(
+          child: Text(
+              'Action: Call Rust `greet("Tom")`\nResult: `${greet(name: "Tom")}`'),
+        ),
+      ),
+    );
+  }
+}

frb_codegen/assets/integration_template/plugin/lib/REPLACE_ME_DART_PACKAGE_NAME.dart

@@ -0,0 +1,4 @@
+library REPLACE_ME_DART_PACKAGE_NAME;
+
+export 'src/rust/api/simple.dart';
+export 'src/rust/frb_generated.dart' show RustLib;

frb_codegen/src/binary/commands.rs

@@ -1,5 +1,6 @@
 use crate::codegen::ConfigDumpContent;
-use clap::{Args, Parser, Subcommand};
+use clap::{Args, Parser, Subcommand, ValueEnum};
+use lib_flutter_rust_bridge_codegen::misc::Template;
 use std::path::PathBuf;
 
 // The name `Cli`, `Commands` come from https://docs.rs/clap/latest/clap/_derive/_tutorial/chapter_0/index.html
@@ -184,6 +185,10 @@ pub(crate) struct CreateCommandArgs {
 
     #[clap(flatten)]
     pub common: CreateOrIntegrateCommandCommonArgs,
+
+    /// The template type to use to generate the flutter files.
+    #[clap(short, long, value_enum, default_value = "app")]
+    pub template: TemplateArg
 }
 
 #[derive(Debug, Args)]
@@ -194,6 +199,19 @@ pub(crate) struct IntegrateCommandArgs {
 
     #[clap(flatten)]
     pub common: CreateOrIntegrateCommandCommonArgs,
+
+    /// The template type to use for integration. This should usually match the type of flutter project
+    /// being integrating with.
+    #[clap(short, long, value_enum, default_value = "app")]
+    pub template: TemplateArg
+}
+
+#[derive(Debug,Clone,ValueEnum)]
+pub(crate) enum TemplateArg {
+    /// (default) a Flutter application
+    App,
+    /// A shareable Flutter project that can be used across multiple Flutter applictions.
+    Plugin,
 }
 
 #[derive(Debug, Args)]
@@ -229,3 +247,13 @@ pub(crate) struct BuildWebCommandArgs {
 
 #[derive(Debug, Args)]
 pub(crate) struct InternalGenerateCommandArgs {}
+
+
+impl From<TemplateArg> for Template {
+    fn from(value: TemplateArg) -> Self {
+        match value {
+            TemplateArg::App => Template::App,
+            TemplateArg::Plugin => Template::Plugin,
+        }
+    }
+}

frb_codegen/src/library/commands/flutter.rs

@@ -1,15 +1,20 @@
 use crate::command_run;
 use crate::commands::command_runner::call_shell;
 use crate::library::commands::command_runner::check_exit_code;
+use crate::misc::Template;
 use log::info;
 use std::path::Path;
 
 #[allow(clippy::vec_init_then_push)]
-pub fn flutter_create(name: &str, org: &Option<String>) -> anyhow::Result<()> {
+pub fn flutter_create(name: &str, org: &Option<String>, template: Template) -> anyhow::Result<()> {
     let mut args = vec![name];
     if let Some(o) = org {
         args.extend(["--org", o]);
     }
+    match template {
+        Template::App => args.extend(["--template","app"]),
+        Template::Plugin => args.extend(["--template","plugin","--platforms", "android,ios,linux,macos,windows,web"]),
+    }
     info!(
         "Execute `flutter create {}` (this may take a while)",
         args.join(" ")

frb_codegen/src/library/commands/mod.rs

@@ -8,4 +8,4 @@ pub(crate) mod ensure_tools_available;
 pub(crate) mod ffigen;
 pub(crate) mod flutter;
 pub(crate) mod format_dart;
-pub(crate) mod format_rust;
+pub(crate) mod format_rust;

frb_codegen/src/library/integration/creator.rs

@@ -1,7 +1,8 @@
 use crate::integration::integrator;
 use crate::integration::integrator::IntegrateConfig;
 use crate::library::commands::flutter::flutter_create;
-use anyhow::ensure;
+use crate::misc::Template;
+use anyhow::{bail, ensure};
 use log::{debug, info};
 use std::path::Path;
 use std::{env, fs};
@@ -12,6 +13,7 @@ pub struct CreateConfig {
     pub enable_local_dependency: bool,
     pub rust_crate_name: Option<String>,
     pub rust_crate_dir: String,
+    pub template: Template,
 }
 
 /// Create a new Flutter + Rust project.
@@ -31,26 +33,65 @@ pub fn create(config: CreateConfig) -> anyhow::Result<()> {
     );
     // frb-coverage:ignore-end
 
-    flutter_create(&config.name, &config.org)?;
+    flutter_create(&config.name, &config.org, config.template)?;
 
     env::set_current_dir(&dart_root)?;
 
-    remove_unnecessary_files(&dart_root)?;
-
+    match &config.template {
+        Template::App => remove_unnecessary_app_files(&dart_root)?,
+        Template::Plugin => remove_unnecessary_plugin_files(&dart_root)?,
+    }
+
     info!("Step: Inject flutter_rust_bridge related code");
     integrator::integrate(IntegrateConfig {
         enable_integration_test: true,
         enable_local_dependency: config.enable_local_dependency,
         rust_crate_name: config.rust_crate_name,
         rust_crate_dir: config.rust_crate_dir,
+        template: config.template,
     })
 }
 
 // the function signature is not covered while the whole body is covered - looks like a bug in coverage tool
 // frb-coverage:ignore-start
-fn remove_unnecessary_files(dart_root: &Path) -> anyhow::Result<()> {
+fn remove_unnecessary_app_files(dart_root: &Path) -> anyhow::Result<()> {
+    // frb-coverage:ignore-end
+    let lib_dir = dart_root.join("lib");
+    let test_dir = dart_root.join("test");
+
+    remove_files_in_dir(&lib_dir)?;
+    remove_files_in_dir(&test_dir)?;
+
+    Ok(())
+}
+
+// the function signature is not covered while the whole body is covered - looks like a bug in coverage tool
+// frb-coverage:ignore-start
+fn remove_unnecessary_plugin_files(dart_root: &Path) -> anyhow::Result<()> {
     // frb-coverage:ignore-end
-    fs::remove_file(dart_root.join("test").join("widget_test.dart"))?;
-    fs::remove_file(dart_root.join("lib").join("main.dart"))?;
+    let lib_dir = dart_root.join("lib");
+    let test_dir = dart_root.join("test");
+    let example_lib_dir = dart_root.join("example").join("lib");
+    let example_integration_test_dir = dart_root.join("example").join("integration_test");
+
+    remove_files_in_dir(&lib_dir)?;
+    remove_files_in_dir(&test_dir)?;
+    remove_files_in_dir(&example_lib_dir)?;
+    remove_files_in_dir(&example_integration_test_dir)?;
+
     Ok(())
 }
+
+
+fn remove_files_in_dir(dir: &Path) -> anyhow::Result<()> {
+    for entry in fs::read_dir(dir)? {
+        let entry = entry?;
+        let path = entry.path();
+        if path.is_file() {
+            fs::remove_file(&path)?;
+        } else if path.is_dir() {
+            bail!("An unexpected directory was encountered: {:?}", path);
+        }
+    }
+    Ok(())
+}