🎯 Goal

I have updated the README because the logging setup code shown in it differs from the actual implementation, which could cause confusion for developers using this plugin.

🛠 Implementation details

https://github.com/skydoves/compose-stability-analyzer?tab=readme-ov-file#configure-custom-logger--enable-logging

AS IS

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()

        // Enable recomposition tracking ONLY in debug builds
        LoggerProvider.setEnabled(BuildConfig.DEBUG)
    }
}

Important Note

• If you don't enable LoggerProvider, no logs will appear even with @TraceRecomposition

TO BE

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()

        // Enable recomposition tracking ONLY in debug builds
        ComposeStabilityAnalyzer.setEnabled(BuildConfig.DEBUG)
    }
}

Important Note

• If you don't enable ComposeStabilityAnalyzer, no logs will appear even with @TraceRecomposition

✍️ Explain examples

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()

        // Enable recomposition tracking ONLY in debug builds
        LoggerProvider.setEnabled(BuildConfig.DEBUG)
    }
}

When writing the code as above and building it, the following error occurs.

Unresolved reference 'LoggerProvider'.

refernece

https://github.com/YAPP-Github/Reed-Android/pull/211/files

Question

I'm wondering if LoggerProvider is not an actual class name but rather a descriptive term that encompasses both the default logger and custom loggers.

I could only find the name LoggerProvider in the LoggerProviderTest class and comments within the project.

Thank you for creating such an excellent plugin!

Summary by CodeRabbit

• Documentation
  • Updated setup instructions for enabling recomposition logging in debug builds to reflect API changes.