fix: Apply Spotless & Fix Convention Plugins

build-logic/README.md

@@ -29,10 +29,10 @@ setup.
 
 Current list of convention plugins:
 
-- [`mifospay.android.application`](convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt),
-  [`mifospay.android.library`](convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt),
-  [`mifospay.android.test`](convention/src/main/kotlin/AndroidTestConventionPlugin.kt):
+- [`android.application`](convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt),
+  [`android.library`](convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt),
+  [`android.test`](convention/src/main/kotlin/AndroidTestConventionPlugin.kt):
   Configures common Android and Kotlin options.
-- [`mifospay.android.application.compose`](convention/src/main/kotlin/AndroidApplicationComposeConventionPlugin.kt),
-  [`mifospay.android.library.compose`](convention/src/main/kotlin/AndroidLibraryComposeConventionPlugin.kt):
+- [`android.application.compose`](convention/src/main/kotlin/AndroidApplicationComposeConventionPlugin.kt),
+  [`android.library.compose`](convention/src/main/kotlin/AndroidLibraryComposeConventionPlugin.kt):
   Configures Jetpack Compose options

build-logic/convention/build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
     `kotlin-dsl`
 }
 
-group = "org.mifospay.buildlogic"
+group = "org.mifos.buildlogic"
 
 // Configure the build-logic plugins to target JDK 19
 // This matches the JDK used to build the project, and is not related to what is running on device.
@@ -42,53 +42,53 @@ gradlePlugin {
     plugins {
         // Android Plugins
         register("androidApplicationCompose") {
-            id = "mifospay.android.application.compose"
+            id = "org.mifos.android.application.compose"
             implementationClass = "AndroidApplicationComposeConventionPlugin"
         }
         register("androidApplication") {
-            id = "mifospay.android.application"
+            id = "org.mifos.android.application"
             implementationClass = "AndroidApplicationConventionPlugin"
         }
 
         register("androidFlavors") {
-            id = "mifospay.android.application.flavors"
+            id = "org.mifos.android.application.flavors"
             implementationClass = "AndroidApplicationFlavorsConventionPlugin"
         }
 
         // KMP & CMP Plugins
         register("cmpFeature") {
-            id = "mifospay.cmp.feature"
+            id = "org.mifos.cmp.feature"
             implementationClass = "CMPFeatureConventionPlugin"
         }
 
         register("kmpKoin") {
-            id = "mifospay.kmp.koin"
+            id = "org.mifos.kmp.koin"
             implementationClass = "KMPKoinConventionPlugin"
         }
         register("kmpLibrary") {
-            id = "mifospay.kmp.library"
+            id = "org.mifos.kmp.library"
             implementationClass = "KMPLibraryConventionPlugin"
         }
 
         // Static Analysis & Formatting Plugins
         register("detekt") {
-            id = "mifos.detekt.plugin"
-            implementationClass = "MifosDetektConventionPlugin"
+            id = "org.mifos.detekt.plugin"
+            implementationClass = "DetektConventionPlugin"
             description = "Configures detekt for the project"
         }
         register("spotless") {
-            id = "mifos.spotless.plugin"
-            implementationClass = "MifosSpotlessConventionPlugin"
+            id = "org.mifos.spotless.plugin"
+            implementationClass = "SpotlessConventionPlugin"
             description = "Configures spotless for the project"
         }
         register("ktlint") {
-            id = "mifos.ktlint.plugin"
-            implementationClass = "MifosKtlintConventionPlugin"
+            id = "org.mifos.ktlint.plugin"
+            implementationClass = "KtlintConventionPlugin"
             description = "Configures kotlinter for the project"
         }
         register("gitHooks") {
-            id = "mifos.git.hooks"
-            implementationClass = "MifosGitHooksConventionPlugin"
+            id = "org.mifos.git.hooks"
+            implementationClass = "GitHooksConventionPlugin"
             description = "Installs git hooks for the project"
         }
     }

build-logic/convention/src/main/kotlin/AndroidApplicationComposeConventionPlugin.kt

@@ -5,6 +5,9 @@ import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.getByType
 import org.mifos.configureAndroidCompose
 
+/**
+ * Plugin that applies the Android application and Compose plugins and configures them.
+ */
 class AndroidApplicationComposeConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {

build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt

@@ -9,16 +9,19 @@ import org.mifos.configureBadgingTasks
 import org.mifos.configureKotlinAndroid
 import org.mifos.configurePrintApksTask
 
+/**
+ * Plugin that applies the Android application plugin and configures it.
+ */
 class AndroidApplicationConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             with(pluginManager) {
                 apply("com.android.application")
                 apply("org.jetbrains.kotlin.android")
                 apply("com.dropbox.dependency-guard")
-                apply("mifos.detekt.plugin")
-                apply("mifos.spotless.plugin")
-                apply("mifos.git.hooks")
+                apply("org.mifos.detekt.plugin")
+                apply("org.mifos.spotless.plugin")
+                apply("org.mifos.git.hooks")
             }
 
             extensions.configure<ApplicationExtension> {

build-logic/convention/src/main/kotlin/AndroidApplicationFlavorsConventionPlugin.kt

@@ -4,6 +4,9 @@ import org.gradle.api.Project
 import org.gradle.kotlin.dsl.configure
 import org.mifos.configureFlavors
 
+/**
+ * Plugin that applies the Android application flavors plugin and configures it.
+ */
 class AndroidApplicationFlavorsConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {

build-logic/convention/src/main/kotlin/CMPFeatureConventionPlugin.kt

@@ -4,14 +4,27 @@ import org.gradle.api.Project
 import org.gradle.kotlin.dsl.dependencies
 import org.mifos.libs
 
+/**
+ * Plugin that applies the CMP feature plugin and configures it.
+ * This plugin applies the following plugins:
+ * - org.mifos.kmp.library - Kotlin Multiplatform Library
+ * - org.mifos.kmp.koin - Koin for Kotlin Multiplatform
+ * - org.jetbrains.kotlin.plugin.compose - Kotlin Compose
+ * - org.jetbrains.compose - Compose Multiplatform
+ * - org.mifos.detekt.plugin - Detekt Plugin
+ * - org.mifos.spotless.plugin - Spotless Plugin
+ *
+ */
 class CMPFeatureConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             pluginManager.apply {
-                apply("mifospay.kmp.library")
-                apply("mifospay.kmp.koin")
+                apply("org.mifos.kmp.library")
+                apply("org.mifos.kmp.koin")
                 apply("org.jetbrains.kotlin.plugin.compose")
                 apply("org.jetbrains.compose")
+                apply("org.mifos.detekt.plugin")
+                apply("org.mifos.spotless.plugin")
             }
 
             dependencies {

build-logic/convention/src/main/kotlin/MifosDetektConventionPlugin.kt → build-logic/convention/src/main/kotlin/DetektConventionPlugin.kt

@@ -4,7 +4,10 @@ import org.gradle.api.Project
 import org.mifos.configureDetekt
 import org.mifos.detektGradle
 
-class MifosDetektConventionPlugin : Plugin<Project> {
+/**
+ * Plugin that applies the Detekt plugin and configures it.
+ */
+class DetektConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             applyPlugins()

build-logic/convention/src/main/kotlin/MifosGitHooksConventionPlugin.kt → build-logic/convention/src/main/kotlin/GitHooksConventionPlugin.kt

@@ -6,7 +6,10 @@ import org.gradle.api.tasks.Exec
 import org.gradle.kotlin.dsl.register
 import java.util.Locale
 
-class MifosGitHooksConventionPlugin : Plugin<Project> {
+/**
+ * Plugin that installs the pre-commit git hooks from the scripts directory.
+ */
+class GitHooksConventionPlugin : Plugin<Project> {
     override fun apply(project: Project) {
         // Define a function to check if the OS is Linux or MacOS
         fun isLinuxOrMacOs(): Boolean {

build-logic/convention/src/main/kotlin/KMPKoinConventionPlugin.kt

@@ -4,7 +4,9 @@ import org.gradle.api.Project
 import org.gradle.kotlin.dsl.dependencies
 import org.mifos.libs
 
-
+/**
+ * Plugin that applies the Koin plugin and configures it.
+ */
 class KMPKoinConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {

build-logic/convention/src/main/kotlin/KMPLibraryConventionPlugin.kt

@@ -9,15 +9,18 @@ import org.mifos.configureKotlinAndroid
 import org.mifos.configureKotlinMultiplatform
 import org.mifos.libs
 
+/**
+ * Plugin that applies the Android library and Kotlin multiplatform plugins and configures them.
+ */
 class KMPLibraryConventionPlugin: Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             with(pluginManager) {
                 apply("com.android.library")
                 apply("org.jetbrains.kotlin.multiplatform")
-                apply("mifospay.kmp.koin")
-                apply("mifos.detekt.plugin")
-                apply("mifos.spotless.plugin")
+                apply("org.mifos.kmp.koin")
+                apply("org.mifos.detekt.plugin")
+                apply("org.mifos.spotless.plugin")
             }
 
             configureKotlinMultiplatform()

build-logic/convention/src/main/kotlin/MifosKtlintConventionPlugin.kt → build-logic/convention/src/main/kotlin/KtlintConventionPlugin.kt

@@ -1,7 +1,10 @@
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 
-class MifosKtlintConventionPlugin : Plugin<Project> {
+/**
+ * Plugin that applies the Ktlint plugin and configures it.
+ */
+class KtlintConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             applyPlugins()

build-logic/convention/src/main/kotlin/MifosSpotlessConventionPlugin.kt → build-logic/convention/src/main/kotlin/SpotlessConventionPlugin.kt

@@ -3,7 +3,10 @@ import org.gradle.api.Project
 import org.mifos.configureSpotless
 import org.mifos.spotlessGradle
 
-class MifosSpotlessConventionPlugin : Plugin<Project> {
+/**
+ * Plugin that applies the Spotless plugin and configures it.
+ */
+class SpotlessConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             applyPlugins()

build-logic/convention/src/main/kotlin/org/mifos/MifosBuildType.kt → build-logic/convention/src/main/kotlin/org/mifos/AppBuildType.kt

@@ -3,7 +3,7 @@ package org.mifos
 /**
  * This is shared between :app and :benchmarks module to provide configurations type safety.
  */
-enum class MifosBuildType(val applicationIdSuffix: String? = null) {
+enum class AppBuildType(val applicationIdSuffix: String? = null) {
     DEBUG(".debug"),
     RELEASE,
 }

build-logic/convention/src/main/kotlin/org/mifos/MifosFlavor.kt → build-logic/convention/src/main/kotlin/org/mifos/AppFlavor.kt

@@ -14,19 +14,25 @@ enum class FlavorDimension {
 // purposes, or from a production backend server which supplies up-to-date, real content.
 // These two product flavors reflect this behaviour.
 @Suppress("EnumEntryName")
-enum class MifosFlavor(val dimension: FlavorDimension, val applicationIdSuffix: String? = null) {
+enum class AppFlavor(val dimension: FlavorDimension, val applicationIdSuffix: String? = null) {
     demo(FlavorDimension.contentType, applicationIdSuffix = ".demo"),
     prod(FlavorDimension.contentType)
 }
 
+/**
+ * Configure product flavors for the app module
+ * @param commonExtension the common extension for the app module
+ * @param flavorConfigurationBlock the configuration block for each flavor
+ * @see AppFlavor
+ */
 fun configureFlavors(
     commonExtension: CommonExtension<*, *, *, *, *, *>,
-    flavorConfigurationBlock: ProductFlavor.(flavor: MifosFlavor) -> Unit = {}
+    flavorConfigurationBlock: ProductFlavor.(flavor: AppFlavor) -> Unit = {},
 ) {
     commonExtension.apply {
         flavorDimensions += FlavorDimension.contentType.name
         productFlavors {
-            MifosFlavor.values().forEach {
+            AppFlavor.values().forEach {
                 create(it.name) {
                     dimension = it.dimension.name
                     flavorConfigurationBlock(this, it)

build-logic/convention/src/main/kotlin/org/mifos/Badging.kt

@@ -24,8 +24,16 @@ import org.gradle.kotlin.dsl.register
 import org.gradle.language.base.plugins.LifecycleBasePlugin
 import org.gradle.process.ExecOperations
 import java.io.File
+import java.util.Locale
 import javax.inject.Inject
 
+/**
+ * Generates the badging information of the APK.
+ * This task is cacheable, meaning that if the inputs and outputs have not changed,
+ * the task will be considered up-to-date and will not run.
+ * This task is also incremental, meaning that if the inputs have not changed,
+ *
+ */
 @CacheableTask
 abstract class GenerateBadgingTask : DefaultTask() {
 
@@ -97,7 +105,11 @@ fun Project.configureBadgingTasks(
     // Registers a callback to be called, when a new variant is configured
     componentsExtension.onVariants { variant ->
         // Registers a new task to verify the app bundle.
-        val capitalizedVariantName = variant.name.capitalized()
+        val capitalizedVariantName = variant.name.let {
+            if (it.isEmpty()) it else it[0].titlecase(
+                Locale.getDefault(),
+            ) + it.substring(1)
+        }
         val generateBadgingTaskName = "generate${capitalizedVariantName}Badging"
         val generateBadging =
             tasks.register<GenerateBadgingTask>(generateBadgingTaskName) {

build-logic/convention/src/main/kotlin/org/mifos/Detekt.kt

@@ -6,6 +6,13 @@ import org.gradle.api.Project
 import org.gradle.kotlin.dsl.dependencies
 import org.gradle.kotlin.dsl.named
 
+/**
+ * Configures the Detekt plugin with the [extension] configuration.
+ * This includes setting the JVM target to 17 and enabling all reports.
+ * Additionally, it adds the `detekt-formatting` and `twitter-detekt-compose` plugins.
+ * @see DetektExtension
+ * @see Detekt
+ */
 internal fun Project.configureDetekt(extension: DetektExtension) = extension.apply {
     tasks.named<Detekt>("detekt") {
         jvmTarget = "17"

build-logic/convention/src/main/kotlin/org/mifos/KotlinMultiplatform.kt

@@ -6,6 +6,12 @@ import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
 
+/**
+ * Configure the Kotlin Multiplatform plugin with the default hierarchy template and additional targets.
+ * This includes JVM, Android, iOS, JS and WASM targets.
+ * @see KotlinMultiplatformExtension
+ * @see configure
+ */
 @OptIn(ExperimentalWasmDsl::class, ExperimentalKotlinGradlePluginApi::class)
 internal fun Project.configureKotlinMultiplatform() {
     extensions.configure<KotlinMultiplatformExtension> {

build-logic/convention/src/main/kotlin/org/mifos/PrintTestApks.kt

@@ -20,6 +20,14 @@ import org.gradle.api.tasks.TaskAction
 import org.gradle.work.DisableCachingByDefault
 import java.io.File
 
+/**
+ * Configures the `printTestApks` task for the [project].
+ * This task will print the location of the androidTest APKs.
+ * This is useful when running tests on a device or emulator.
+ * The task will only be created if there are androidTest sources.
+ * @see PrintApkLocationTask
+ * @see HasAndroidTest
+ */
 internal fun Project.configurePrintApksTask(extension: AndroidComponentsExtension<*, *, *>) {
     extension.onVariants { variant ->
         if (variant is HasAndroidTest) {
@@ -37,7 +45,7 @@ internal fun Project.configurePrintApksTask(extension: AndroidComponentsExtensio
             if (artifact != null && testSources != null) {
                 tasks.register(
                     "${variant.name}PrintTestApk",
-                    PrintApkLocationTask::class.java
+                    PrintApkLocationTask::class.java,
                 ) {
                     apkFolder.set(artifact)
                     builtArtifactsLoader.set(loader)

build-logic/convention/src/main/kotlin/org/mifos/ProjectExtensions.kt

@@ -8,17 +8,29 @@ import org.gradle.api.artifacts.VersionCatalogsExtension
 import org.gradle.kotlin.dsl.configure
 import org.gradle.kotlin.dsl.getByType
 
+/**
+ * Get the `libs` version catalog.
+ */
 val Project.libs
     get(): VersionCatalog = extensions.getByType<VersionCatalogsExtension>().named("libs")
 
+/**
+ * Get the dynamic version of the project.
+ */
 val Project.dynamicVersion
     get() = project.version.toString().split('+')[0]
 
+/**
+ * Configures the `detekt` plugin with the [configure] lambda.
+ */
 inline fun Project.detektGradle(crossinline configure: DetektExtension.() -> Unit) =
     extensions.configure<DetektExtension> {
         configure()
     }
 
+/**
+ * Configures the `spotless` plugin with the [configure] lambda.
+ */
 inline fun Project.spotlessGradle(crossinline configure: SpotlessExtension.() -> Unit) =
     extensions.configure<SpotlessExtension> {
         configure()