mirror of
				https://github.com/InsanusMokrassar/KSLog.git
				synced 2025-11-04 05:20:38 +00:00 
			
		
		
		
	Compare commits
	
		
			16 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 1be14aa28e | |||
| 97b432c0b0 | |||
| 74a0ad8fd1 | |||
| 502dd4d607 | |||
| 079fbaa7f4 | |||
| 99dac12a27 | |||
| b0cc6c11ea | |||
| 58161132dc | |||
| 7e45e5d421 | |||
| e7956f6d31 | |||
| 9993fd5fdd | |||
| 9e8665cdc9 | |||
| 63d3cabc9c | |||
| 0b142c7ff9 | |||
| 7a1d934dab | |||
| b3720de8c7 | 
							
								
								
									
										18
									
								
								CHANGELOG.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								CHANGELOG.md
									
									
									
									
									
								
							@@ -1,5 +1,23 @@
 | 
				
			|||||||
# Changelog
 | 
					# Changelog
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 0.5.4
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					* `Kotlin`: `1.7.22`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 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
 | 
					## 0.5.1
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* New property `defaultMessageFormatterWithErrorPrint` for messages format with errors
 | 
					* New property `defaultMessageFormatterWithErrorPrint` for messages format with errors
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										23
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										23
									
								
								README.md
									
									
									
									
									
								
							@@ -1,18 +1,33 @@
 | 
				
			|||||||
# How to use
 | 
					# KSLog
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					It is simple and easy-to-use tool for logging on the most popular platforms in Kotlin Multiplatform:
 | 
				
			||||||
 | 
					
 | 
				
			||||||

 | 
					
 | 
				
			||||||

 | 
					
 | 
				
			||||||

 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[](https://insanusmokrassar.github.io/KSLog/)
 | 
					[](https://insanusmokrassar.github.io/KSLog/)
 | 
				
			||||||
[](https://bookstack.inmo.dev/books/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`
 | 
					* `java.util.logging.Logger` for `JVM`
 | 
				
			||||||
* `android.util.Log` for `Android`
 | 
					* `android.util.Log` for `Android`
 | 
				
			||||||
* `Console` for `JS`
 | 
					* `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
 | 
					## How to use
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Fast-travel
 | 
					### Fast-travel
 | 
				
			||||||
@@ -39,9 +54,11 @@ KSLog.l(LogLevel.INFO, "Some optional tag", IllegalArgumentException("So, that i
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
There are several important "terms" in context of this library:
 | 
					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`)
 | 
					* Local logger (can be created via `KSLog` functions and passed anywhere as `KSLog`)
 | 
				
			||||||
* Logging shortcuts like `KSLog.i`/`KSLog.info`
 | 
					* 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.
 | 
					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 {
 | 
					    android {
 | 
				
			||||||
        publishAllLibraryVariants()
 | 
					        publishAllLibraryVariants()
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
 | 
					    linuxArm64()
 | 
				
			||||||
 | 
					    linuxArm32Hfp()
 | 
				
			||||||
 | 
					    linuxX64()
 | 
				
			||||||
 | 
					    wasm32()
 | 
				
			||||||
 | 
					    mingwX64()
 | 
				
			||||||
 | 
					    mingwX86()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    sourceSets {
 | 
					    sourceSets {
 | 
				
			||||||
        commonMain {
 | 
					        commonMain {
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -5,9 +5,10 @@ kotlin.incremental=true
 | 
				
			|||||||
kotlin.incremental.js=true
 | 
					kotlin.incremental.js=true
 | 
				
			||||||
android.useAndroidX=true
 | 
					android.useAndroidX=true
 | 
				
			||||||
android.enableJetifier=true
 | 
					android.enableJetifier=true
 | 
				
			||||||
 | 
					org.gradle.jvmargs=-Xmx196m
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Project data
 | 
					# Project data
 | 
				
			||||||
 | 
					
 | 
				
			||||||
group=dev.inmo
 | 
					group=dev.inmo
 | 
				
			||||||
version=0.5.1
 | 
					version=0.5.4
 | 
				
			||||||
android_code_version=14
 | 
					android_code_version=17
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,16 +1,18 @@
 | 
				
			|||||||
[versions]
 | 
					[versions]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
kotlin = "1.7.10"
 | 
					kotlin = "1.7.22"
 | 
				
			||||||
kotlin-gradle-plugin = "7.2.2"
 | 
					kotlin-gradle-plugin = "7.2.2"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					dokka = "1.7.20"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
dexcount = "3.1.0"
 | 
					dexcount = "3.1.0"
 | 
				
			||||||
junit_version = "4.12"
 | 
					junit_version = "4.12"
 | 
				
			||||||
test_ext_junit_version = "1.1.3"
 | 
					test_ext_junit_version = "1.1.3"
 | 
				
			||||||
espresso_core = "3.4.0"
 | 
					espresso_core = "3.4.0"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
android-minSdk = "21"
 | 
					android-minSdk = "21"
 | 
				
			||||||
android-compileSdk = "32"
 | 
					android-compileSdk = "33"
 | 
				
			||||||
android-buildTools = "32.0.0"
 | 
					android-buildTools = "33.0.0"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
github-release = "2.4.1"
 | 
					github-release = "2.4.1"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -29,10 +31,10 @@ android-test-espresso-core = { module = "androidx.test.espresso:espresso-core",
 | 
				
			|||||||
android-tools-build = { module = "com.android.tools.build:gradle", version.ref = "kotlin-gradle-plugin" }
 | 
					android-tools-build = { module = "com.android.tools.build:gradle", version.ref = "kotlin-gradle-plugin" }
 | 
				
			||||||
android-dexcount = { module = "com.getkeepsafe.dexcount:dexcount-gradle-plugin", version.ref = "dexcount" }
 | 
					android-dexcount = { module = "com.getkeepsafe.dexcount:dexcount-gradle-plugin", version.ref = "dexcount" }
 | 
				
			||||||
kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 | 
					kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 | 
				
			||||||
kotlin-dokka-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "kotlin" }
 | 
					kotlin-dokka-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
 | 
				
			||||||
github-release = { module = "com.github.breadmoirai:github-release", version.ref = "github-release" }
 | 
					github-release = { module = "com.github.breadmoirai:github-release", version.ref = "github-release" }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[plugins]
 | 
					[plugins]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 | 
					kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 | 
				
			||||||
kotlin-dokka = { id = "org.jetbrains.dokka", version.ref = "kotlin" }
 | 
					kotlin-dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -62,6 +62,9 @@ interface KSLog {
 | 
				
			|||||||
operator fun KSLog.invoke(performLogCallback: (level: LogLevel, tag: String?, message: Any, throwable: Throwable?) -> Unit) = CallbackKSLog(performLogCallback)
 | 
					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 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(
 | 
					fun KSLog(
 | 
				
			||||||
    defaultTag: String,
 | 
					    defaultTag: String,
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										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