Compare commits

...

16 Commits

14 changed files with 83 additions and 13 deletions

View File

@@ -1,5 +1,27 @@
# Changelog
## 0.5.3
* `Kotlin`: `1.7.20`
## 0.5.2
* Add support of next platform:
* Linux ARM x64
* Linux ARM x32 HFP
* Linux x64
* WASM x32
* MinGW x64
* MinGW x86
## 0.5.1
* New property `defaultMessageFormatterWithErrorPrint` for messages format with errors
## 0.5.0
* `Kotlin`: `1.7.10`
## 0.4.2
* Add `setDefaultKSLog` and `addDefaultKSLog`

View File

@@ -1,4 +1,6 @@
# How to use
# KSLog
It is simple and easy-to-use tool for logging on the most popular platforms in Kotlin Multiplatform:
![JVM](https://img.shields.io/badge/JVM-red?style=for-the-badge&logo=openjdk&logoColor=white)
![Android](https://img.shields.io/badge/Android-green?style=for-the-badge&logo=android&logoColor=white)
@@ -7,12 +9,22 @@
[![KDocs](https://img.shields.io/badge/KDocs-323330?style=for-the-badge&logo=Kotlin&logoColor=7F52FF)](https://insanusmokrassar.github.io/KSLog/)
[![Tutorials](https://img.shields.io/badge/Tutorials-0288D1?style=for-the-badge&logo=bookstack&logoColor=white)](https://bookstack.inmo.dev/books/kslog)
It is simple logging tool which is using built-in tools for logging:
By default, KSLog is using built-in tools for logging on each supported platform:
* `java.util.logging.Logger` for `JVM`
* `android.util.Log` for `Android`
* `Console` for `JS`
But you always may create your logger and customize as you wish:
```kotlin
KSLog.default = KSLog { level: LogLevel, tag: String?, message: Any, throwable: Throwable? ->
// do your logging
}
```
**This library also supports native targets in experimental mode. By default all native targets will use simple printing in the console**
## How to use
### Fast-travel
@@ -39,9 +51,11 @@ KSLog.l(LogLevel.INFO, "Some optional tag", IllegalArgumentException("So, that i
There are several important "terms" in context of this library:
* Default logger (available via `KSLog.default`)
* Default logger (available via `KSLog.default` or simply `KSLog`)
* Local logger (can be created via `KSLog` functions and passed anywhere as `KSLog`)
* Logging shortcuts like `KSLog.i`/`KSLog.info`
* Built-in extension `Any.logger` which allow you to create logger binded to the default with the tag based on the class of receiver
* __Be careful with the receivers: if you will use some extension like `apply`, the receiver will be different with your class inside of that `apply`__
Every logging extension (like `KSLog.i`) have its analog with lazy inited message text and the same one with suffix `S` (like `KSLog.iS`) for the suspendable message calculation.

View File

@@ -47,6 +47,12 @@ kotlin {
android {
publishAllLibraryVariants()
}
linuxArm64()
linuxArm32Hfp()
linuxX64()
wasm32()
mingwX64()
mingwX86()
sourceSets {
commonMain {

View File

@@ -5,9 +5,10 @@ kotlin.incremental=true
kotlin.incremental.js=true
android.useAndroidX=true
android.enableJetifier=true
org.gradle.jvmargs=-Xmx196m
# Project data
group=dev.inmo
version=0.4.2
android_code_version=12
version=0.5.3
android_code_version=16

View File

@@ -1,16 +1,16 @@
[versions]
kotlin = "1.6.21"
kotlin-gradle-plugin = "7.0.4"
kotlin = "1.7.20"
kotlin-gradle-plugin = "7.2.2"
dexcount = "3.1.0"
junit_version = "4.12"
test_ext_junit_version = "1.1.2"
espresso_core = "3.3.0"
test_ext_junit_version = "1.1.3"
espresso_core = "3.4.0"
android-minSdk = "21"
android-compileSdk = "32"
android-buildTools = "32.0.0"
android-compileSdk = "33"
android-buildTools = "33.0.0"
github-release = "2.4.1"

View File

@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

View File

@@ -62,6 +62,9 @@ interface KSLog {
operator fun KSLog.invoke(performLogCallback: (level: LogLevel, tag: String?, message: Any, throwable: Throwable?) -> Unit) = CallbackKSLog(performLogCallback)
internal expect val defaultLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit
internal val printlnLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit = { l, t, m, e ->
println(defaultMessageFormatter(l, t, m, e))
}
fun KSLog(
defaultTag: String,

View File

@@ -5,4 +5,4 @@ typealias MessageFormatter = (l: LogLevel, t: String?, m: Any, Throwable?) -> St
inline fun MessageFormatter(noinline formatter: MessageFormatter) = formatter
typealias MessageFilter = (l: LogLevel, t: String?, Throwable?) -> Boolean
val defaultMessageFormatter: MessageFormatter = { l, t, m, _ -> "[$l] ${t ?.let { "$it " } ?: ""}- $m" }
val defaultMessageFormatterWithErrorPrint: MessageFormatter = { l, t, m, e -> "[$l] ${t ?.let { "$it " } ?: ""}- $m${e ?.let { ": ${it.stackTraceToString()}" } ?: ""}" }

View File

@@ -0,0 +1,4 @@
package dev.inmo.kslog.common
internal actual val defaultLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit
get() = printlnLogging

View File

@@ -0,0 +1,4 @@
package dev.inmo.kslog.common
internal actual val defaultLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit
get() = printlnLogging

View File

@@ -0,0 +1,4 @@
package dev.inmo.kslog.common
internal actual val defaultLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit
get() = printlnLogging

View File

@@ -0,0 +1,4 @@
package dev.inmo.kslog.common
internal actual val defaultLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit
get() = printlnLogging

View File

@@ -0,0 +1,4 @@
package dev.inmo.kslog.common
internal actual val defaultLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit
get() = printlnLogging

View File

@@ -0,0 +1,4 @@
package dev.inmo.kslog.common
internal actual val defaultLogging: (level: LogLevel, tag: String, message: Any, throwable: Throwable?) -> Unit
get() = printlnLogging