Recomposition Logger

This plugin makes it easy to debug composable functions by adding logs to each function. The plugin also highlights composable functions during recomposition

sample_record.mov

requirements:

v1.7.2: kotlin 1.9.20
v1.7.1: kotlin 1.9.10
v1.7.0: kotlin 1.9.0
v1.6.x: kotlin 1.8.21
v1.5.0: kotlin 1.8.20
v1.4.0: kotlin 1.8.10
v1.3.0: kotlin 1.8.0
v1.2.0: kotlin 1.7.20
v1.1.0: kotlin 1.7.0

Integration

root build.gradle

buildscript {
    repositories {
       // ...
       mavenCentral()  
    }
    dependencies {
        // ...
      classpath("com.welltech:recomposition-logger-plugin:$version")
    }
}

app build.gradle.kts

plugins {
  id("com.welltech.recomposition-logger-plugin")
}

Also, you can configure plugin in your app:build.gradle.kts

recompositionLogger {
  tag = "SampleRecomposition" // tag for recomposition logs
}

Other plugin options:

enabled [Boolean] - when false, the plugin doesn't add any additional code. By default, it's false for release build and true for debug build
tag [String, default: "RecompositionLog"] - tag for recomposition logs.
useRebugger [Boolean] - use Rebugger for logging (experimental)

Features

Highlighting recomposition

To enable highlight you should update debugHighlightOptions property

class YourApplication : Application() {

    override fun onCreate() {
      super.onCreate()
      debugHighlightOptions = debugHighlightOptions.copy(enabled = true)
    }
}

You can change debugHighlightOptions in runtime:

@Composable
fun ScreenContent() {
  //...
  //...
  Button(
    onClick = { debugHighlightOptions = debugHighlightOptions.copy(enabled = !debugHighlightOptions.enabled) },
    content = { Text(text = "Change highlighting") }
  )
}

You can disable logs and highlighting for specific function using annotation @DisableLogs. It may be useful for root composables (like scaffold)

@Composable
@DisableLogs
fun AppScaffold(
  //...
) {
   //... 
}

You can improve logs by LogArgument annotation:

@Composable
fun Item(
  @LogArgument title: String
) {
    Text(text = title)
}