mirror of
https://github.com/InsanusMokrassar/KSLog.git
synced 2025-10-27 17:40:07 +00:00
Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a71405aff5 | |||
| a2b497d0f9 | |||
| c5974fb51c | |||
| 3240b63f21 | |||
| fffafc4da7 | |||
| b1d5ce2135 | |||
| 0b8db9be35 | |||
| 5030ecc255 | |||
| b5669d2187 | |||
| ed7ad35605 | |||
| 6d5ddafefc | |||
| ee31c61677 | |||
| 1be14aa28e | |||
| 97b432c0b0 | |||
| 74a0ad8fd1 | |||
| 502dd4d607 | |||
| 079fbaa7f4 | |||
| 99dac12a27 | |||
| b0cc6c11ea | |||
| 58161132dc | |||
| 7e45e5d421 | |||
| e7956f6d31 | |||
| 9993fd5fdd | |||
| 9e8665cdc9 | |||
| 63d3cabc9c | |||
| 0b142c7ff9 | |||
| 7a1d934dab | |||
| b3720de8c7 |
8
.github/workflows/publish.yml
vendored
8
.github/workflows/publish.yml
vendored
@@ -8,9 +8,6 @@ jobs:
|
|||||||
- uses: actions/setup-java@v1
|
- uses: actions/setup-java@v1
|
||||||
with:
|
with:
|
||||||
java-version: 11
|
java-version: 11
|
||||||
- name: Fix android 32.0.0 dx
|
|
||||||
continue-on-error: true
|
|
||||||
run: cd /usr/local/lib/android/sdk/build-tools/32.0.0/ && mv d8 dx && cd lib && mv d8.jar dx.jar
|
|
||||||
- name: Rewrite version
|
- name: Rewrite version
|
||||||
run: |
|
run: |
|
||||||
branch="`echo "${{ github.ref }}" | grep -o "[^/]*$"`"
|
branch="`echo "${{ github.ref }}" | grep -o "[^/]*$"`"
|
||||||
@@ -19,6 +16,11 @@ jobs:
|
|||||||
mv gradle.properties.tmp gradle.properties
|
mv gradle.properties.tmp gradle.properties
|
||||||
- name: Build
|
- name: Build
|
||||||
run: ./gradlew build
|
run: ./gradlew build
|
||||||
|
- name: Publish to Gitea
|
||||||
|
continue-on-error: true
|
||||||
|
run: ./gradlew publishAllPublicationsToGiteaRepository
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
- name: Publish
|
- name: Publish
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
run: ./gradlew --no-parallel publishAllPublicationsToGithubPackagesRepository
|
run: ./gradlew --no-parallel publishAllPublicationsToGithubPackagesRepository
|
||||||
|
|||||||
27
CHANGELOG.md
27
CHANGELOG.md
@@ -1,5 +1,32 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 1.1.0
|
||||||
|
|
||||||
|
* `Kotlin`: `1.8.20`
|
||||||
|
* Standard factory `KSLog` with `String` arg now use `TagLogger`
|
||||||
|
|
||||||
|
## 1.0.0
|
||||||
|
|
||||||
|
* `Kotlin`: `1.8.0`
|
||||||
|
|
||||||
|
## 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=-Xmx512m
|
||||||
|
|
||||||
# Project data
|
# Project data
|
||||||
|
|
||||||
group=dev.inmo
|
group=dev.inmo
|
||||||
version=0.5.1
|
version=1.1.0
|
||||||
android_code_version=14
|
android_code_version=19
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
[versions]
|
[versions]
|
||||||
|
|
||||||
kotlin = "1.7.10"
|
kotlin = "1.8.20"
|
||||||
kotlin-gradle-plugin = "7.2.2"
|
kotlin-gradle-plugin = "7.3.1"
|
||||||
|
|
||||||
|
dokka = "1.8.10"
|
||||||
|
|
||||||
dexcount = "3.1.0"
|
dexcount = "3.1.0"
|
||||||
junit_version = "4.12"
|
junit_version = "4.12"
|
||||||
@@ -9,8 +11,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.1"
|
||||||
|
|
||||||
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" }
|
||||||
|
|||||||
@@ -49,20 +49,40 @@ publishing {
|
|||||||
maven {
|
maven {
|
||||||
name = "GithubPackages"
|
name = "GithubPackages"
|
||||||
url = uri("https://maven.pkg.github.com/InsanusMokrassar/KSLog")
|
url = uri("https://maven.pkg.github.com/InsanusMokrassar/KSLog")
|
||||||
|
|
||||||
credentials {
|
credentials {
|
||||||
username = project.hasProperty('GITHUBPACKAGES_USER') ? project.property('GITHUBPACKAGES_USER') : System.getenv('GITHUBPACKAGES_USER')
|
username = project.hasProperty('GITHUBPACKAGES_USER') ? project.property('GITHUBPACKAGES_USER') : System.getenv('GITHUBPACKAGES_USER')
|
||||||
password = project.hasProperty('GITHUBPACKAGES_PASSWORD') ? project.property('GITHUBPACKAGES_PASSWORD') : System.getenv('GITHUBPACKAGES_PASSWORD')
|
password = project.hasProperty('GITHUBPACKAGES_PASSWORD') ? project.property('GITHUBPACKAGES_PASSWORD') : System.getenv('GITHUBPACKAGES_PASSWORD')
|
||||||
}
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (project.hasProperty('GITEA_TOKEN') || System.getenv('GITEA_TOKEN') != null) {
|
||||||
|
maven {
|
||||||
|
name = "Gitea"
|
||||||
|
url = uri("https://git.inmo.dev/api/packages/InsanusMokrassar/maven")
|
||||||
|
|
||||||
|
credentials(HttpHeaderCredentials) {
|
||||||
|
name = "Authorization"
|
||||||
|
value = project.hasProperty('GITEA_TOKEN') ? project.property('GITEA_TOKEN') : System.getenv('GITEA_TOKEN')
|
||||||
|
}
|
||||||
|
|
||||||
|
authentication {
|
||||||
|
header(HttpHeaderAuthentication)
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
||||||
maven {
|
maven {
|
||||||
name = "sonatype"
|
name = "sonatype"
|
||||||
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
|
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
|
||||||
|
|
||||||
credentials {
|
credentials {
|
||||||
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
|
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
|
||||||
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
|
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
{"licenses":[{"id":"MIT","title":"MIT License","url":"https://opensource.org/licenses/MIT"}],"mavenConfig":{"name":"${project.name}","description":"Simple logging library for kotlin","url":"https://github.com/InsanusMokrassar/KSLog","vcsUrl":"https://github.com/InsanusMokrassar/KSLog.git","developers":[{"id":"Akkihi","name":"Akkihi","eMail":"akkihiguy@gmail.com"},{"id":"InsanusMokrassar","name":"InsanusMokrassar","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"GithubPackages","url":"https://maven.pkg.github.com/InsanusMokrassar/KSLog"},{"name":"sonatype","url":"https://oss.sonatype.org/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}}}
|
{"licenses":[{"id":"MIT","title":"MIT License","url":"https://opensource.org/licenses/MIT"}],"mavenConfig":{"name":"${project.name}","description":"Simple logging library for kotlin","url":"https://github.com/InsanusMokrassar/KSLog","vcsUrl":"https://github.com/InsanusMokrassar/KSLog.git","developers":[{"id":"Akkihi","name":"Akkihi","eMail":"akkihiguy@gmail.com"},{"id":"InsanusMokrassar","name":"InsanusMokrassar","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"GithubPackages","url":"https://maven.pkg.github.com/InsanusMokrassar/KSLog"},{"name":"Gitea","url":"https://git.inmo.dev/api/packages/InsanusMokrassar/maven","credsType":{"type":"dev.inmo.kmppscriptbuilder.core.models.MavenPublishingRepository.CredentialsType.HttpHeaderCredentials","headerName":"Authorization","headerValueProperty":"GITEA_TOKEN"}},{"name":"sonatype","url":"https://oss.sonatype.org/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}}}
|
||||||
@@ -62,10 +62,17 @@ 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,
|
||||||
messageFormatter: MessageFormatter = defaultMessageFormatter
|
): KSLog = TagLogger(defaultTag)
|
||||||
|
|
||||||
|
fun KSLog(
|
||||||
|
defaultTag: String,
|
||||||
|
messageFormatter: MessageFormatter
|
||||||
): KSLog = DefaultKSLog(
|
): KSLog = DefaultKSLog(
|
||||||
defaultTag,
|
defaultTag,
|
||||||
messageFormatter
|
messageFormatter
|
||||||
@@ -76,11 +83,10 @@ fun KSLog(
|
|||||||
defaultTag: String,
|
defaultTag: String,
|
||||||
filter: MessageFilter,
|
filter: MessageFilter,
|
||||||
messageFormatter: MessageFormatter = defaultMessageFormatter
|
messageFormatter: MessageFormatter = defaultMessageFormatter
|
||||||
): KSLog = DefaultKSLog(
|
): KSLog = KSLog (
|
||||||
defaultTag,
|
defaultTag,
|
||||||
filter,
|
|
||||||
messageFormatter
|
messageFormatter
|
||||||
)
|
).filtered(filter)
|
||||||
|
|
||||||
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