Koin Annotations

Setup Koin Annotations for your project

Version

You can find all Koin packages on maven central.

Here are the current available versions:

Setup & Current Version

Here are the current available Koin projects versions:

Project	Version
koin-annotations-bom
koin-annotations
koin-ksp-compiler

KSP Plugin

We need KSP Plugin to work (https://github.com/google/ksp). Just add the Gradle plugin:

ksp_version = "1.8.21-1.0.11"

//at your project root

plugins {
    id "com.google.devtools.ksp" version "$ksp_version"
}

Kotlin App Setup

Here below how you can configure a Kotlin (even a Ktor) app:

// Use KSP Plugin
apply plugin: 'com.google.devtools.ksp'

// Use KSP Generated sources
sourceSets.main {
    java.srcDirs("build/generated/ksp/main/kotlin")
}

dependencies {
    // Koin
    compile "io.insert-koin:koin-core:$koin_version"
    compile "io.insert-koin:koin-annotations:$koin_ksp_version"
    ksp "io.insert-koin:koin-ksp-compiler:$koin_ksp_version"
}

Android App Setup

Here below how you can configure an Android app:

// Use KSP Plugin
apply plugin: 'com.google.devtools.ksp'

// Use KSP Generated sources
android {
    applicationVariants.all { variant ->
        variant.sourceSets.java.each {
            it.srcDirs += "build/generated/ksp/${variant.name}/kotlin"
        }
    }
}

dependencies {
    // Koin for Android
    implementation "io.insert-koin:koin-android:$koin_version"
    implementation "io.insert-koin:koin-annotations:$koin_ksp_version"
    ksp "io.insert-koin:koin-ksp-compiler:$koin_ksp_version"
}

If you use several KSP libraries (like Room), you can use this way of declaring generated sources:

libraryVariants.all { variant ->
  variant.addJavaSourceFoldersToModel(file("build/generated/ksp/${variant.name}/kotlin"))
}

Kotlin KMP Setup

Please follow KSP setup as described in official documentation: KSP with Kotlin Multiplatform

You can also check the Hello Koin KMP project with basic setup for Koin Annotations.