Compare commits

...

25 Commits

Author SHA1 Message Date
7e45e5d421 Update CHANGELOG.md 2022-11-03 13:27:02 +06:00
e7956f6d31 Update README.md 2022-11-03 13:22:23 +06:00
9993fd5fdd Update libs.versions.toml 2022-11-03 13:11:51 +06:00
9e8665cdc9 Update gradle.properties 2022-11-03 13:09:32 +06:00
63d3cabc9c Merge pull request #19 from InsanusMokrassar/0.5.2
0.5.2
2022-09-12 15:46:27 +06:00
0b142c7ff9 add native platforms support 2022-09-12 15:44:59 +06:00
7a1d934dab start 0.5.2 2022-09-12 15:07:22 +06:00
b3720de8c7 Merge pull request #18 from InsanusMokrassar/0.5.1
0.5.1
2022-08-18 12:44:17 +06:00
669afe481d add defaultMessageFormatterWithErrorPrint 2022-08-13 20:19:21 +06:00
42db9da058 update gradle wrapper 2022-08-13 20:12:44 +06:00
72de26adac start 0.5.1 2022-08-13 20:12:19 +06:00
4b47a4e817 Merge pull request #17 from InsanusMokrassar/0.5.0
0.5.0
2022-08-04 17:19:33 +06:00
785ab59519 Update CHANGELOG.md 2022-08-04 16:57:38 +06:00
a4f2562690 Update libs.versions.toml 2022-08-04 16:56:30 +06:00
777ae44da5 Update gradle.properties 2022-08-04 16:54:14 +06:00
28d61a7b7c Merge pull request #16 from InsanusMokrassar/0.4.2
0.4.2
2022-07-31 19:26:54 +06:00
66c5451293 now tag in MessageFormatter is a nullable 2022-07-31 19:22:08 +06:00
77ca9ce25b MessageFormatter factory 2022-07-31 19:19:17 +06:00
194e52f521 addDefaultKSLog 2022-07-31 19:15:53 +06:00
34ea0bd91a isolate logging of KSLog'gers to avoid problems with parallel logs perform 2022-07-31 19:13:02 +06:00
3ff5d989b7 KSLog(SimpleKSLogCallback) 2022-07-31 19:09:01 +06:00
0e01534562 setDefaultKSLog and KSLog#plus(KSLog) 2022-07-31 19:06:57 +06:00
35e3d02837 start 0.4.2 2022-07-31 19:01:25 +06:00
b255406dba Update CHANGELOG.md 2022-07-30 17:13:55 +06:00
88fa4e3c09 Merge pull request #15 from InsanusMokrassar/0.4.1
0.4.1
2022-07-30 17:12:14 +06:00
16 changed files with 119 additions and 15 deletions

View File

@@ -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**

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.1
android_code_version=11
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

@@ -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)

View File

@@ -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 }

View File

@@ -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()}" } ?: ""}" }

View 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 }
}

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