mirror of
https://github.com/InsanusMokrassar/KSLog.git
synced 2025-10-27 17:40:07 +00:00
Compare commits
25 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 7e45e5d421 | |||
| e7956f6d31 | |||
| 9993fd5fdd | |||
| 9e8665cdc9 | |||
| 63d3cabc9c | |||
| 0b142c7ff9 | |||
| 7a1d934dab | |||
| b3720de8c7 | |||
| 669afe481d | |||
| 42db9da058 | |||
| 72de26adac | |||
| 4b47a4e817 | |||
| 785ab59519 | |||
| a4f2562690 | |||
| 777ae44da5 | |||
| 28d61a7b7c | |||
| 66c5451293 | |||
| 77ca9ce25b | |||
| 194e52f521 | |||
| 34ea0bd91a | |||
| 3ff5d989b7 | |||
| 0e01534562 | |||
| 35e3d02837 | |||
| b255406dba | |||
| 88fa4e3c09 |
31
CHANGELOG.md
31
CHANGELOG.md
@@ -1,7 +1,38 @@
|
||||
# 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`
|
||||
* Add `plus` operation for two `KSLog` instances to call them both on each log performing
|
||||
* Add `KSLog` factory for simple creation of `CallbackKSLog`
|
||||
* Add `MessageFormatter` factory
|
||||
|
||||
## 0.4.1
|
||||
|
||||
* Fixes in resolution ambiguity for functions with messages
|
||||
|
||||
## 0.4.0
|
||||
|
||||
**THIS UPDATE CONTAINS BREAKING CHANGES**
|
||||
|
||||
20
README.md
20
README.md
@@ -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:
|
||||
|
||||

|
||||

|
||||
@@ -7,12 +9,22 @@
|
||||
[](https://insanusmokrassar.github.io/KSLog/)
|
||||
[](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.
|
||||
|
||||
|
||||
@@ -47,6 +47,12 @@ kotlin {
|
||||
android {
|
||||
publishAllLibraryVariants()
|
||||
}
|
||||
linuxArm64()
|
||||
linuxArm32Hfp()
|
||||
linuxX64()
|
||||
wasm32()
|
||||
mingwX64()
|
||||
mingwX86()
|
||||
|
||||
sourceSets {
|
||||
commonMain {
|
||||
|
||||
@@ -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.1
|
||||
android_code_version=11
|
||||
version=0.5.3
|
||||
android_code_version=16
|
||||
|
||||
@@ -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"
|
||||
|
||||
|
||||
2
gradle/wrapper/gradle-wrapper.properties
vendored
2
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -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
|
||||
|
||||
@@ -7,3 +7,7 @@ class CallbackKSLog(
|
||||
) : KSLog {
|
||||
override fun performLog(level: LogLevel, tag: String?, message: Any, throwable: Throwable?) = performLogCallback(level, tag, message, throwable)
|
||||
}
|
||||
|
||||
fun KSLog(
|
||||
performLogCallback: SimpleKSLogCallback
|
||||
) = CallbackKSLog(performLogCallback)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package dev.inmo.kslog.common
|
||||
|
||||
import dev.inmo.kslog.common.filter.filtered
|
||||
import dev.inmo.kslog.common.utils.plus
|
||||
|
||||
|
||||
enum class LogLevel {
|
||||
@@ -61,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,
|
||||
@@ -110,3 +114,6 @@ fun KSLog(
|
||||
).filtered { l, _, _ ->
|
||||
minLoggingLevel.ordinal <= l.ordinal
|
||||
}
|
||||
|
||||
fun setDefaultKSLog(newDefault: KSLog) { KSLog.default = newDefault }
|
||||
fun addDefaultKSLog(newDefault: KSLog) { KSLog.default = KSLog.default + newDefault }
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
package dev.inmo.kslog.common
|
||||
|
||||
typealias MessageFormatter = (l: LogLevel, t: String, m: Any, Throwable?) -> String
|
||||
typealias MessageFormatter = (l: LogLevel, t: String?, m: Any, Throwable?) -> String
|
||||
@Suppress("NOTHING_TO_INLINE")
|
||||
inline fun MessageFormatter(noinline formatter: MessageFormatter) = formatter
|
||||
typealias MessageFilter = (l: LogLevel, t: String?, Throwable?) -> Boolean
|
||||
val defaultMessageFormatter: MessageFormatter = { l, t, m, _ -> "[$l] $t - $m" }
|
||||
|
||||
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()}" } ?: ""}" }
|
||||
|
||||
15
src/commonMain/kotlin/utils/Combination.kt
Normal file
15
src/commonMain/kotlin/utils/Combination.kt
Normal file
@@ -0,0 +1,15 @@
|
||||
package dev.inmo.kslog.common.utils
|
||||
|
||||
import dev.inmo.kslog.common.CallbackKSLog
|
||||
import dev.inmo.kslog.common.KSLog
|
||||
|
||||
infix operator fun KSLog.plus(other: KSLog) = CallbackKSLog { l, t, m, e ->
|
||||
val resultOfFirst = runCatching {
|
||||
this@plus.performLog(l, t, m, e)
|
||||
}
|
||||
val resultOfSecond = runCatching {
|
||||
other.performLog(l, t, m, e)
|
||||
}
|
||||
resultOfFirst.onFailure { throw it }
|
||||
resultOfSecond.onFailure { throw it }
|
||||
}
|
||||
4
src/linuxArm32HfpMain/kotlin/DefaultLoggingActual.kt
Normal file
4
src/linuxArm32HfpMain/kotlin/DefaultLoggingActual.kt
Normal 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
|
||||
4
src/linuxArm64Main/kotlin/defaultLogging.kt
Normal file
4
src/linuxArm64Main/kotlin/defaultLogging.kt
Normal 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
|
||||
4
src/linuxX64Main/kotlin/defaultLogging.kt
Normal file
4
src/linuxX64Main/kotlin/defaultLogging.kt
Normal 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
|
||||
4
src/mingwX64Main/kotlin/defaultLogging.kt
Normal file
4
src/mingwX64Main/kotlin/defaultLogging.kt
Normal 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
|
||||
4
src/mingwX86Main/kotlin/defaultLogging.kt
Normal file
4
src/mingwX86Main/kotlin/defaultLogging.kt
Normal 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
|
||||
4
src/wasm32Main/kotlin/defaultLogging.kt
Normal file
4
src/wasm32Main/kotlin/defaultLogging.kt
Normal 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
|
||||
Reference in New Issue
Block a user