Merge pull request #1 from buijs-dev/develop

Develop

Author: buijs-dev

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.2.0
+* Uses Klutter Gradle v2022.r6-8.alpha.
+* New project template uses Klutter DSL to apply Klutter dependencies.
+* Flutter generated files are removed from lib folder after klutter init.
+* Moved task klutterInstallPlatform from generated build.gradle.kts to Gradle plugin.
+* Renamed task klutterInstallPlatfrom to klutterBuild.
+* Moved task klutterCopyAarFile from generated build.gradle.kts to Gradle plugin.
+* Moved task klutterIosFramework from generated build.gradle.kts to Gradle plugin.
+* Changed platform build.gradle.kts to create an XCFramework instead of fat framework for iOS.
+* [Bugfix](https://github.com/buijs-dev/klutter/issues/4) App does not work on Mac M1.
+
 ## 0.1.3
 * Uses Klutter Gradle v2022.r6-7.alpha.
 

README.md

@@ -1,11 +1,12 @@
-[<img src="https://github.com/buijs-dev/klutter-dart/blob/main/logo_animated.gif?raw=true" width="300" alt="buijs software logo" />](https://github.com/buijs-dev)
-
-# Klutter
 [![GitHub license](https://img.shields.io/github/license/buijs-dev/klutter-dart?color=black&logoColor=black&style=for-the-badge)](https://github.com/buijs-dev/klutter-dart/blob/main/LICENSE)
 [![pub](https://img.shields.io/pub/v/klutter?style=for-the-badge)](https://pub.dev/packages/klutter)
 [![codecov](https://img.shields.io/codecov/c/github/buijs-dev/klutter-dart?logo=codecov&style=for-the-badge)](https://codecov.io/gh/buijs-dev/klutter-dart)
 [![CodeScene Code Health](https://img.shields.io/badge/CODESCENE-10-brightgreen?style=for-the-badge)](https://codescene.io/projects/27237)
 
+<br>
+
+<img src="https://github.com/buijs-dev/klutter/blob/develop/.github/assets/metadata/icon/klutter_logo.png?raw=true" alt="buijs software logo" />
+
 The Klutter Framework makes it possible to write a Flutter plugin for both Android
 and iOS using [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html).
 Instead of writing platform specific code twice in 2 languages (Swift + Kotlin),
@@ -24,12 +25,13 @@ Use this plugin if you want to:
 1. [Installation](#Installation)
 2. [Using plugins](#Usage)
 3. [Creating plugins](#Creation)
+4. [FAQ!](#Faq!)
 
 For a step-by-step guide, see the battery app with Klutter [tutorial](https://buijs.dev/klutter-2/).
 
 # Installation
 <b>What's the point?</b></br>
-Plugins build with the Klutter Framework work slightly different than regular plugins. 
+Plugins build with the Klutter Framework work slightly different from regular plugins. 
 The Klutter dependency is a requirement for both using and creating plugins with Klutter.
 
 <b>Steps:</b></br>
@@ -48,14 +50,14 @@ flutter pub get
 
 # Usage
 <b>What's the point?</b></br>
-Plugins build with the Klutter Framework work slightly different than regular plugins. 
+Plugins build with the Klutter Framework work slightly different from regular plugins. 
 The following tasks help Flutter to locate Klutter plugins 
 and ensure compatibility between Flutter Android/IOS configuration and Klutter plugin Android/IOS configuration.
 
 <b>Steps:</b></br>
 1. Installation.
-3. Initialization.
-4. Add dependencies.
+2. Initialization.
+3. Add dependencies.
 
 Install Klutter as dependency as described [here](#Installation).
 
@@ -65,8 +67,8 @@ Initialize Klutter in your project by running:
 flutter pub run klutter:consumer init
 ```  
 
-The init task will setup Klutter for both Android and iOS.
-Alternatively you can setup Android and IOS separately.
+The init task will set up Klutter for both Android and iOS.
+Alternatively you can set up Android and IOS separately.
 
 Setup Android by running:  
 
@@ -80,7 +82,7 @@ Setup IOS by running:
 flutter pub run klutter:consumer init=ios
 ```  
 
-Finally Klutter plugins can be added by running the add command.
+Finally, Klutter plugins can be added by running the add command.
 
 <B>Example</B>:</br> Add the library 'awesome_plugin' to your project:
 
@@ -174,4 +176,34 @@ flutter pub run klutter:producer install=library
 ```
 
 Now test the plugin by following the steps outlined [here](#Usage) in the root/example project. 
-When done you can run the example project from the root/example/lib folder and see your first plugin in action!
+When done you can run the example project from the root/example/lib folder and see your first plugin in action!
+
+# Faq!
+1. [App won't start on...](#App%20won't%20start)
+
+## App won't start
+
+Make sure you have followed all the following steps:
+- flutter create <your_plugin_name> --org <your_organisation> --template=plugin --platforms=android,ios.
+- [klutter](https://pub.dev/packages/klutter) is added to the dependencies in your pubspec.yaml 
+(both the plugin and plugin/example for testing).
+- do flutter pub get in both root and root/example folder.
+- do flutter pub run klutter:producer init in the root folder.
+- do flutter pub run klutter:producer install=library in the root folder.
+- do flutter pub run klutter:producer install=platform in the root folder.
+- do flutter pub run klutter:consumer init in the root/example folder.
+- do flutter pub run klutter:consumer add=<your_plugin_name> in the root/example folder.
+
+### For Android emulator:
+There should be a .klutter-plugins file in the root/example folder containing an entry for your plugin.
+If not then do flutter pub run klutter:consumer add=<your_plugin_name> in the root/example folder again.
+
+There should be a platform.aar file in the root/android/klutter folder. If not then do flutter pub run
+klutter:producer install=platform from the root folder.
+
+### For iOS simulator:
+There should be a Platform.xcframework folder in root/ios/Klutter. If not then do flutter pub run
+klutter:producer install=platform from the root folder.
+
+If there's an error message saying unable to find plugin or similar then run pod update in the root/example/ios
+folder.

bin/consumer.dart

@@ -29,11 +29,13 @@ import "package:klutter/klutter.dart";
 Future<void> main(List<String> args) async {
   print("""
   ════════════════════════════════════════════
-     KLUTTER (v0.1.3)                               
+     KLUTTER (v$klutterPubVersion)                               
   ════════════════════════════════════════════
   """
       .ok);
 
+  print("This might take a while. Just a moment please...".boring);
+
   final pathToRoot = Directory.current.absolutePath;
   final result = await execute(
     script: ScriptName.consumer,

bin/producer.dart

@@ -29,11 +29,13 @@ import "package:klutter/klutter.dart";
 Future<void> main(List<String> args) async {
   print("""
   ════════════════════════════════════════════
-     KLUTTER (v0.1.3)                               
+     KLUTTER (v$klutterPubVersion)                               
   ════════════════════════════════════════════
   """
       .ok);
 
+  print("This might take a while. Just a moment please...".boring);
+
   final pathToRoot = Directory.current.absolutePath;
   final result = await execute(
     script: ScriptName.producer,

example/README.md

@@ -1,4 +1,5 @@
-[<img src="https://github.com/buijs-dev/klutter-dart/blob/main/logo_animated.gif?raw=true" width="300" alt="buijs software logo" />](https://github.com/buijs-dev)
+<br />
+<img src="https://github.com/buijs-dev/klutter/blob/develop/.github/assets/metadata/icon/klutter_logo.png?raw=true" alt="buijs software logo" />
 
 - For installation instructions see [here](./../README.md).
 - For a step-by-step guide, see the battery app with Klutter [tutorial](https://buijs.dev/klutter-2/).

lib/res/gradle.properties

@@ -8,6 +8,5 @@ kotlin.code.style=official
 android.useAndroidX=true
 
 #MPP
-kotlin.mpp.enableGranularSourceSetsMetadata=true
-kotlin.native.enableDependencyPropagation=false
-kotlin.mpp.enableCInteropCommonization=true
+kotlin.mpp.enableCInteropCommonization=true
+kotlin.mpp.stability.nowarn=true

lib/src/cli/cli.dart

@@ -127,4 +127,7 @@ extension ColoredMessage on String {
 
   /// Log a red colored message.
   String get nok => "\x1B[31m${this}";
+
+  /// Default color (mostly whit(e/ish)).
+  String get boring => "\x1B[49m${this}";
 }

lib/src/cli/command.dart

@@ -52,7 +52,7 @@ class Command {
   }) {
     /// Regex to parse the CLI arguments.
     final taskRegex = RegExp(
-      r"^\s*(init|add|install)\s*=*\s*([^\s]+|$)",
+      r"^\s*(init|add|install)\s*=*\s*(\S+|$)",
     );
 
     final match = taskRegex.firstMatch(task);

lib/src/cli/task_producer_init.dart

@@ -18,6 +18,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+import "dart:io";
+
 import "../common/project.dart";
 import "../common/utilities.dart";
 import "../producer/android.dart";
@@ -46,6 +48,12 @@ class ProducerInit extends Task {
 
 extension on String {
   void get setupRoot {
+    Directory("${this}/lib".normalize)
+      // Delete folder and all children if they exist.
+      ..normalizeToFolder.maybeDelete
+      // Create a new empty lib folder.
+      ..maybeCreate;
+
     final name = findPluginName(this);
     writeGradleProperties(this);
 

lib/src/cli/task_producer_install.dart

@@ -96,7 +96,7 @@ void _installPlatform(String pathToRoot) {
 
   final result = Process.runSync(
     "./gradlew",
-    ["klutterInstallPlatform"],
+    ["klutterBuild"],
     workingDirectory: pathToRoot,
     environment: {"ANDROID_SDK_ROOT": androidSdkLocation},
   );

lib/src/common/config.dart

@@ -1,5 +1,8 @@
+/// The version of the Klutter Pub Plugin.
+const klutterPubVersion = "0.2.0";
+
 /// The version of the Klutter Gradle Plugin.
-const klutterGradleVersion = "2022.r6-7.alpha";
+const klutterGradleVersion = "2022.r6-8.alpha";
 
 /// The minimum SDK version for Android.
 const androidMinSdk = 21;

lib/src/common/utilities.dart

@@ -55,6 +55,14 @@ extension FileUtil on FileSystemEntity {
     return this;
   }
 
+  /// Check if the Directory exists and then delete it.
+  FileSystemEntity get maybeDelete {
+    if (existsSync()) {
+      deleteSync(recursive: true);
+    }
+    return this;
+  }
+
   /// Return absolute path of current File or Folder as String.
   String get absolutePath => absolute.path;
 

lib/src/consumer/ios.dart

@@ -59,9 +59,9 @@ void excludeArm64FromPodfile(String pathToIos) =>
 
 extension on String {
   /// Return File path to the ios/Podfile.
-  File get toPodfile => File("${this}/Podfile".normalize)
-    ..ifNotExists((folder) =>
-        throw KlutterException("Missing Podfile in folder: ${this}"));
+  File get toPodfile {
+    return File("${this}/Podfile".normalize);
+  }
 }
 
 extension on File {
@@ -70,6 +70,10 @@ extension on File {
   ///
   /// Without doing this the app won't start on a simulator.
   void get writeExclusionLines {
+    if (!existsSync()) {
+      return;
+    }
+
     // Used to check if adding exclusion lines is done.
     var hasAdded = false;
 

lib/src/producer/android.dart

@@ -194,7 +194,7 @@ class _Configuration {
         |    dependencies {
         |        classpath 'com.android.tools.build:gradle:7.0.4'
         |        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.10"
-        |        classpath "dev.buijs.klutter:core:$klutterGradleVersion"
+        |        classpath "dev.buijs.klutter:kore:$klutterGradleVersion"
         |    }
         |}
         |
@@ -233,7 +233,7 @@ class _Configuration {
         |dependencies {
         |    runtimeOnly "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.2"
         |    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10"
-        |    implementation "dev.buijs.klutter:core:$klutterGradleVersion"
+        |    implementation "dev.buijs.klutter:kore:$klutterGradleVersion"
         |    implementation project(":klutter:${packageName.substring(1 + packageName.lastIndexOf("."))}")
         |}
         |

lib/src/producer/ios.dart

@@ -88,7 +88,7 @@ extension on File {
       // This is done so the line is added at a fixed point in the podspec.
       if (line.replaceAll(" ", "").contains("$prefix.dependency'Flutter'")) {
         newLines.add(
-          """  $prefix.ios.vendored_frameworks = "Klutter/Platform.framework" """,
+          """  $prefix.ios.vendored_frameworks = "Klutter/Platform.xcframework" """,
         );
 
         hasAdded = true;