Merge pull request #20 from InsanusMokrassar/0.5.3

0.5.3
This commit is contained in:
InsanusMokrassar 2022-11-03 13:27:17 +06:00 committed by GitHub
commit 58161132dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 8 deletions

View File

@ -1,5 +1,9 @@
# Changelog # Changelog
## 0.5.3
* `Kotlin`: `1.7.20`
## 0.5.2 ## 0.5.2
* Add support of next platform: * Add support of next platform:

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) ![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) ![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/) [![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) [![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` * `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 +51,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.

View File

@ -10,5 +10,5 @@ org.gradle.jvmargs=-Xmx196m
# Project data # Project data
group=dev.inmo group=dev.inmo
version=0.5.2 version=0.5.3
android_code_version=15 android_code_version=16

View File

@ -1,6 +1,6 @@
[versions] [versions]
kotlin = "1.7.10" kotlin = "1.7.20"
kotlin-gradle-plugin = "7.2.2" kotlin-gradle-plugin = "7.2.2"
dexcount = "3.1.0" dexcount = "3.1.0"
@ -9,8 +9,8 @@ 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"