Skip to content

Add a compatibility overload #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samhill303 merged 2 commits into from
Feb 24, 2026
Merged

Add a compatibility overload #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af60f8d
Add a compatibility overload
samhill303 Feb 24, 2026
63f56b4
api updates
samhill303 Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions kermit/api/android/kermit.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,69 @@ public class co/touchlab/kermit/Logger : co/touchlab/kermit/BaseLogger {
public final fun a (Ljava/lang/String;)V
public final fun a (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun a (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun a (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun a (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun a (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun a (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun a (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun a$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun a$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun a$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun d (Ljava/lang/String;)V
public final fun d (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun d (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun d (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun d (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun d (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun d (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun d (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun d$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun d$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun d$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun e (Ljava/lang/String;)V
public final fun e (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun e (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun e (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun e (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun e (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun e (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun e (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun e$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun e$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun e$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public fun getTag ()Ljava/lang/String;
public final fun i (Ljava/lang/String;)V
public final fun i (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun i (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun i (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun i (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun i (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun i (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun i (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun i$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun i$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun i$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun v (Ljava/lang/String;)V
public final fun v (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun v (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun v (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun v (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun v (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun v (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun v (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun v$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun v$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun v$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun w (Ljava/lang/String;)V
public final fun w (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun w (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun w (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun w (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun w (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun w (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun w (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun w$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun w$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun w$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun withTag (Ljava/lang/String;)Lco/touchlab/kermit/Logger;
}
Expand Down
18 changes: 18 additions & 0 deletions kermit/api/jvm/kermit.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,69 @@ public class co/touchlab/kermit/Logger : co/touchlab/kermit/BaseLogger {
public final fun a (Ljava/lang/String;)V
public final fun a (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun a (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun a (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun a (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun a (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun a (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun a (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun a$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun a$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun a$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun d (Ljava/lang/String;)V
public final fun d (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun d (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun d (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun d (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun d (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun d (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun d (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun d$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun d$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun d$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun e (Ljava/lang/String;)V
public final fun e (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun e (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun e (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun e (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun e (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun e (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun e (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun e$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun e$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun e$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public fun getTag ()Ljava/lang/String;
public final fun i (Ljava/lang/String;)V
public final fun i (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun i (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun i (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun i (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun i (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun i (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun i (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun i$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun i$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun i$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun v (Ljava/lang/String;)V
public final fun v (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun v (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun v (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun v (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun v (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun v (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun v (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun v$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun v$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun v$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun w (Ljava/lang/String;)V
public final fun w (Ljava/lang/String;Ljava/lang/Throwable;)V
public final fun w (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;)V
public final fun w (Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun w (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun w (Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)V
public final fun w (Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;)V
public final fun w (Lkotlin/jvm/functions/Function0;)V
public static synthetic fun w$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/String;ILjava/lang/Object;)V
public static synthetic fun w$default (Lco/touchlab/kermit/Logger;Ljava/lang/String;Ljava/lang/Throwable;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public static synthetic fun w$default (Lco/touchlab/kermit/Logger;Ljava/lang/Throwable;Ljava/lang/String;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
public final fun withTag (Ljava/lang/String;)Lco/touchlab/kermit/Logger;
}
Expand Down
114 changes: 114 additions & 0 deletions kermit/src/commonMain/kotlin/co/touchlab/kermit/Logger.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,25 @@ open class Logger(config: LoggerConfig, open val tag: String = "") : BaseLogger(
logBlock(Severity.Verbose, tag, throwable, message)
}

/**
* Log a message with [Severity.Verbose]. This is the lowest severity level.
*
* This overload places [withTag] first, mirroring the former global-logger companion API
* and allowing positional tag-first call sites to compile without changes.
*
* @param withTag Tag to associate with the log message.
* @param throwable Optional throwable to log.
* @param message Lambda returning the message to log.
*/
@Deprecated(
message = "Prefer the throwable-first overload and pass the tag using the named `tag` parameter.",
replaceWith = ReplaceWith("v(throwable = throwable, tag = withTag, message = message)"),
)
@JvmOverloads
inline fun v(withTag: String, throwable: Throwable? = null, message: () -> String) {
logBlock(Severity.Verbose, withTag, throwable, message)
}

/**
* Log a message with [Severity.Debug]. This is above 'Verbose'.
*
Expand All @@ -53,6 +72,25 @@ open class Logger(config: LoggerConfig, open val tag: String = "") : BaseLogger(
logBlock(Severity.Debug, tag, throwable, message)
}

/**
* Log a message with [Severity.Debug]. This is above 'Verbose'.
*
* This overload places [withTag] first, mirroring the former global-logger companion API
* and allowing positional tag-first call sites to compile without changes.
*
* @param withTag Tag to associate with the log message.
* @param throwable Optional throwable to log.
* @param message Lambda returning the message to log.
*/
@Deprecated(
message = "Prefer the throwable-first overload and pass the tag using the named `tag` parameter.",
replaceWith = ReplaceWith("d(throwable = throwable, tag = withTag, message = message)"),
)
@JvmOverloads
inline fun d(withTag: String, throwable: Throwable? = null, message: () -> String) {
logBlock(Severity.Debug, withTag, throwable, message)
}

/**
* Log a message with [Severity.Info]. This is above 'Debug'.
*
Expand All @@ -65,6 +103,25 @@ open class Logger(config: LoggerConfig, open val tag: String = "") : BaseLogger(
logBlock(Severity.Info, tag, throwable, message)
}

/**
* Log a message with [Severity.Info]. This is above 'Debug'.
*
* This overload places [withTag] first, mirroring the former global-logger companion API
* and allowing positional tag-first call sites to compile without changes.
*
* @param withTag Tag to associate with the log message.
* @param throwable Optional throwable to log.
* @param message Lambda returning the message to log.
*/
@Deprecated(
message = "Prefer the throwable-first overload and pass the tag using the named `tag` parameter.",
replaceWith = ReplaceWith("i(throwable = throwable, tag = withTag, message = message)"),
)
@JvmOverloads
inline fun i(withTag: String, throwable: Throwable? = null, message: () -> String) {
logBlock(Severity.Info, withTag, throwable, message)
}

/**
* Log a message with [Severity.Warn]. This is above 'Info'.
*
Expand All @@ -77,6 +134,25 @@ open class Logger(config: LoggerConfig, open val tag: String = "") : BaseLogger(
logBlock(Severity.Warn, tag, throwable, message)
}

/**
* Log a message with [Severity.Warn]. This is above 'Info'.
*
* This overload places [withTag] first, mirroring the former global-logger companion API
* and allowing positional tag-first call sites to compile without changes.
*
* @param withTag Tag to associate with the log message.
* @param throwable Optional throwable to log.
* @param message Lambda returning the message to log.
*/
@Deprecated(
message = "Prefer the throwable-first overload and pass the tag using the named `tag` parameter.",
replaceWith = ReplaceWith("w(throwable = throwable, tag = withTag, message = message)"),
)
@JvmOverloads
inline fun w(withTag: String, throwable: Throwable? = null, message: () -> String) {
logBlock(Severity.Warn, withTag, throwable, message)
}

/**
* Log a message with [Severity.Error]. This is above 'Warn'.
*
Expand All @@ -89,6 +165,25 @@ open class Logger(config: LoggerConfig, open val tag: String = "") : BaseLogger(
logBlock(Severity.Error, tag, throwable, message)
}

/**
* Log a message with [Severity.Error]. This is above 'Warn'.
*
* This overload places [withTag] first, mirroring the former global-logger companion API
* and allowing positional tag-first call sites to compile without changes.
*
* @param withTag Tag to associate with the log message.
* @param throwable Optional throwable to log.
* @param message Lambda returning the message to log.
*/
@Deprecated(
message = "Prefer the throwable-first overload and pass the tag using the named `tag` parameter.",
replaceWith = ReplaceWith("e(throwable = throwable, tag = withTag, message = message)"),
)
@JvmOverloads
inline fun e(withTag: String, throwable: Throwable? = null, message: () -> String) {
logBlock(Severity.Error, withTag, throwable, message)
}

/**
* Log a message with [Severity.Assert]. This is the highest severity level.
*
Expand All @@ -101,6 +196,25 @@ open class Logger(config: LoggerConfig, open val tag: String = "") : BaseLogger(
logBlock(Severity.Assert, tag, throwable, message)
}

/**
* Log a message with [Severity.Assert]. This is the highest severity level.
*
* This overload places [withTag] first, mirroring the former global-logger companion API
* and allowing positional tag-first call sites to compile without changes.
*
* @param withTag Tag to associate with the log message.
* @param throwable Optional throwable to log.
* @param message Lambda returning the message to log.
*/
@Deprecated(
message = "Prefer the throwable-first overload and pass the tag using the named `tag` parameter.",
replaceWith = ReplaceWith("a(throwable = throwable, tag = withTag, message = message)"),
)
@JvmOverloads
inline fun a(withTag: String, throwable: Throwable? = null, message: () -> String) {
logBlock(Severity.Assert, withTag, throwable, message)
}

/**
* Log a message with [Severity.Verbose] using a string message.
*
Expand Down