Skip to content

karmakrafts/Introspekt

Repository files navigation

Introspekt

Introspekt is a positional code API and introspection framework for Kotlin Multiplatform.
It currently adds the following features:

  • SourceLocation type with access to module name, file path, function name, line and column
  • FunctionInfo type for introspecting current/caller function signature and location
  • ClassInfo type for introspecting current/caller classes including functions
  • AnnotationUsageInfo type for introspecting annotation types and their parameters
  • TypeInfo type for fundamental RTTI integrated with kotlin.reflect to fix gaps on Kotlin/JS and other platforms
  • Default-parameter inlining for intrinsic types listed above (like std::source_location in C++)
  • Compile-time evaluation of location hashes to improve runtime performance for positional memoization

How to use it

First, add the official Maven Central repository to your settings.gradle.kts:

pluginManagement {
    repositories {
        maven("https://central.sonatype.com/repository/maven-snapshots")
        mavenCentral()
    }
}

dependencyResolutionManagement {
    repositories {
        maven("https://central.sonatype.com/repository/maven-snapshots")
        mavenCentral()
    }
}

Then add a dependency on the plugin in your root buildscript:

plugins {
    id("dev.karmakrafts.introspekt.introspekt-gradle-plugin") version "<version>"
}

kotlin {
    sourceSets {
        commonMain {
            dependencies {
                implementation("dev.karmakrafts.introspekt:introspekt-runtime:<version>")
            }
        }
    }
}