Formatting fixes (#367)

touchlab · Sep 20, 2023 · ae2b4e8 · ae2b4e8
1 parent d536d6f
commit ae2b4e8
Show file tree

Hide file tree

Showing 70 changed files with 382 additions and 364 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -15,7 +15,7 @@ androidx-navigationUI = "2.7.2"
 androidx-coordinatorLayout = "1.2.0"
 
 android-gradle-plugin = "8.1.1"
-android-test-runner="1.5.2"
+android-test-runner = "1.5.2"
 
 google-services = "4.3.15"
 
@@ -55,7 +55,7 @@ google-services = { module = "com.google.gms:google-services", version.ref = "go
 crashkios-crashlytics = { module = "co.touchlab.crashkios:crashlytics", version.ref = "crashkios" }
 crashkios-bugsnag = { module = "co.touchlab.crashkios:bugsnag", version.ref = "crashkios" }
 bugsnag-android = { module = "com.bugsnag:bugsnag-android", version.ref = "bugsnag" }
-stately-collections = { module = "co.touchlab:stately-collections", version.ref = "stately"}
+stately-collections = { module = "co.touchlab:stately-collections", version.ref = "stately" }
 testhelp = { module = "co.touchlab:testhelp", version.ref = "testhelp" }
 
 koin = { module = "io.insert-koin:koin-core", version.ref = "koin-core" }

diff --git a/kermit-core/build.gradle.kts b/kermit-core/build.gradle.kts
@@ -50,7 +50,7 @@ kotlin {
     androidNativeArm64()
     androidNativeX86()
     androidNativeX64()
-    
+
     sourceSets {
         val commonMain by getting
         val commonTest by getting {
@@ -115,14 +115,17 @@ kotlin {
                         val linuxMain by getting
                         linuxMain
                     }
+
                     konanTarget.family == org.jetbrains.kotlin.konan.target.Family.MINGW -> {
                         val mingwMain by getting
                         mingwMain
                     }
+
                     konanTarget.family == org.jetbrains.kotlin.konan.target.Family.ANDROID -> {
                         val androidNativeMain by getting
                         androidNativeMain
                     }
+
                     else -> nativeMain
                 }
             )

diff --git a/kermit-core/src/androidMain/kotlin/co/touchlab/kermit/LogcatWriter.kt b/kermit-core/src/androidMain/kotlin/co/touchlab/kermit/LogcatWriter.kt
@@ -22,17 +22,17 @@ class LogcatWriter(private val messageStringFormatter: MessageStringFormatter =
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
         val formattedMessage = messageStringFormatter.formatMessage(null, null, Message(message))
         try {
-            if(throwable == null){
-                when(severity){
+            if (throwable == null) {
+                when (severity) {
                     Severity.Verbose -> Log.v(tag, formattedMessage)
                     Severity.Debug -> Log.d(tag, formattedMessage)
                     Severity.Info -> Log.i(tag, formattedMessage)
                     Severity.Warn -> Log.w(tag, formattedMessage)
                     Severity.Error -> Log.e(tag, formattedMessage)
                     Severity.Assert -> Log.wtf(tag, formattedMessage)
                 }
-            }else{
-                when(severity){
+            } else {
+                when (severity) {
                     Severity.Verbose -> Log.v(tag, formattedMessage, throwable)
                     Severity.Debug -> Log.d(tag, formattedMessage, throwable)
                     Severity.Info -> Log.i(tag, formattedMessage, throwable)

diff --git a/kermit-core/src/androidUnitTest/kotlin/co/touchlab/kermit/LogcatLoggerTest.kt b/kermit-core/src/androidUnitTest/kotlin/co/touchlab/kermit/LogcatLoggerTest.kt
@@ -84,8 +84,8 @@ class LogcatLoggerTest {
 
         ShadowLog.getLogs().apply {
             assert(size > 0)
-            assertNotNull(find { it?.throwable?.message?.contains("Root Exception Message")?:false })
-            assertNotNull(find { it?.throwable?.cause?.message?.contains("Cause Exception Message")?:false })
+            assertNotNull(find { it?.throwable?.message?.contains("Root Exception Message") ?: false })
+            assertNotNull(find { it?.throwable?.cause?.message?.contains("Cause Exception Message") ?: false })
         }
     }
 }
diff --git a/kermit-core/src/commonJvmMain/kotlin/co/touchlab/kermit/KermitConfig.kt b/kermit-core/src/commonJvmMain/kotlin/co/touchlab/kermit/KermitConfig.kt
@@ -13,4 +13,5 @@
 
 package co.touchlab.kermit
 
-actual fun mutableLoggerConfigInit(logWriters: List<LogWriter>): MutableLoggerConfig = JvmMutableLoggerConfig(logWriters)
+actual fun mutableLoggerConfigInit(logWriters: List<LogWriter>): MutableLoggerConfig =
+    JvmMutableLoggerConfig(logWriters)
diff --git a/kermit-core/src/commonJvmTest/kotlin/co/touchlab/kermit/LoggerFunctionsTest.kt b/kermit-core/src/commonJvmTest/kotlin/co/touchlab/kermit/LoggerFunctionsTest.kt
@@ -21,7 +21,7 @@ class LoggerFunctionsTest {
 
     @Test
     @Ignore
-    fun tagsWork(){
+    fun tagsWork() {
         TODO()
         /*val testLogWriter = getTestLogWriter()
         Logger.apply {

diff --git a/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/BaseLogger.kt b/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/BaseLogger.kt
@@ -10,11 +10,9 @@
  * or implied. See the License for the specific language governing permissions and limitations under
  * the License.
  */
-@file:Suppress("NOTHING_TO_INLINE")
-
 package co.touchlab.kermit
 
-typealias MessageBlock = ()->String
+typealias MessageBlock = () -> String
 
 /**
  * Base class for public Logger API. Extend to implement your own logger API.

diff --git a/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/ExperimentalKermitApi.kt b/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/ExperimentalKermitApi.kt
@@ -11,4 +11,4 @@
 package co.touchlab.kermit
 
 @RequiresOptIn(level = RequiresOptIn.Level.WARNING)
-annotation class ExperimentalKermitApi()
+annotation class ExperimentalKermitApi
diff --git a/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/LogWriter.kt b/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/LogWriter.kt
@@ -17,7 +17,7 @@ package co.touchlab.kermit
  * Called by Logger to actually send log statements to specific targets. There are several implementations provided by
  * Kermit, but you can supply your own for specific use cases.
  */
-abstract class LogWriter(){
+abstract class LogWriter() {
     open fun isLoggable(tag: String, severity: Severity): Boolean = true
 
     abstract fun log(severity: Severity, message: String, tag: String, throwable: Throwable? = null)

diff --git a/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/MessageStringFormatter.kt b/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/MessageStringFormatter.kt
@@ -22,7 +22,7 @@ interface MessageStringFormatter {
     fun formatTag(tag: Tag) = "(${tag.tag})"
     fun formatMessage(severity: Severity?, tag: Tag?, message: Message): String {
         // Optimize for Android
-        if(severity == null && tag == null)
+        if (severity == null && tag == null)
             return message.message
 
         val sb = StringBuilder()
@@ -35,7 +35,8 @@ interface MessageStringFormatter {
 }
 
 @JvmInline
-value class Tag(val tag:String)
+value class Tag(val tag: String)
+
 @JvmInline
 value class Message(val message: String)
 
@@ -46,20 +47,21 @@ value class Message(val message: String)
  *
  * "[severity: ][(tag) ][message]"
  */
-object DefaultFormatter:MessageStringFormatter
+object DefaultFormatter : MessageStringFormatter
 
 /**
  * Tags are a formal part of Android, but not other systems. This formatter omits them.
  */
-object NoTagFormatter:MessageStringFormatter {
+object NoTagFormatter : MessageStringFormatter {
     override fun formatTag(tag: Tag): String = ""
-    override fun formatMessage(severity: Severity?, tag: Tag?, message: Message): String = super.formatMessage(severity, null, message)
+    override fun formatMessage(severity: Severity?, tag: Tag?, message: Message): String =
+        super.formatMessage(severity, null, message)
 }
 
 /**
  * Just logs the message.
  */
-object SimpleFormatter: MessageStringFormatter {
+object SimpleFormatter : MessageStringFormatter {
     override fun formatTag(tag: Tag): String = ""
     override fun formatMessage(severity: Severity?, tag: Tag?, message: Message): String = message.message
 }
diff --git a/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/MutableLoggerConfig.kt b/kermit-core/src/commonMain/kotlin/co/touchlab/kermit/MutableLoggerConfig.kt
@@ -24,5 +24,8 @@ interface MutableLoggerConfig : LoggerConfig {
 }
 
 expect fun mutableLoggerConfigInit(logWriters: List<LogWriter>): MutableLoggerConfig
-fun mutableLoggerConfigInit(vararg logWriters: LogWriter, minSeverity: Severity = DEFAULT_MIN_SEVERITY):MutableLoggerConfig =
+fun mutableLoggerConfigInit(
+    vararg logWriters: LogWriter,
+    minSeverity: Severity = DEFAULT_MIN_SEVERITY
+): MutableLoggerConfig =
     mutableLoggerConfigInit(logWriters.toList()).also { it.minSeverity = minSeverity }
diff --git a/kermit-core/src/commonTest/kotlin/co/touchlab/kermit/LogFormatterTest.kt b/kermit-core/src/commonTest/kotlin/co/touchlab/kermit/LogFormatterTest.kt
@@ -21,13 +21,13 @@ class LogFormatterTest {
     }
 
     @Test
-    fun noTag(){
+    fun noTag() {
         assertEquals("Warn: Hello", NoTagFormatter.formatMessage(Severity.Warn, Tag("ATag"), Message("Hello")))
         assertEquals("Hello", NoTagFormatter.formatMessage(null, Tag("ATag"), Message("Hello")))
     }
 
     @Test
-    fun simpleFormat(){
+    fun simpleFormat() {
         assertEquals("Hello", SimpleFormatter.formatMessage(Severity.Warn, Tag("ATag"), Message("Hello")))
         assertEquals("Hello", SimpleFormatter.formatMessage(null, Tag("ATag"), Message("Hello")))
         assertEquals("Hello", SimpleFormatter.formatMessage(null, Tag(""), Message("Hello")))

diff --git a/kermit-core/src/darwinMain/kotlin/co/touchlab/kermit/OSLogWriter.kt b/kermit-core/src/darwinMain/kotlin/co/touchlab/kermit/OSLogWriter.kt
@@ -30,7 +30,10 @@ open class OSLogWriter internal constructor(
     private val darwinLogger: DarwinLogger
 ) : LogWriter() {
 
-    constructor(messageStringFormatter: MessageStringFormatter = DefaultFormatter) : this(messageStringFormatter, DarwinLoggerActual)
+    constructor(messageStringFormatter: MessageStringFormatter = DefaultFormatter) : this(
+        messageStringFormatter,
+        DarwinLoggerActual
+    )
 
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
         callLog(
@@ -52,7 +55,7 @@ open class OSLogWriter internal constructor(
     }
 
     @OptIn(ExperimentalNativeApi::class)
-    open fun logThrowable(osLogSeverity: UByte, throwable: Throwable){
+    open fun logThrowable(osLogSeverity: UByte, throwable: Throwable) {
         darwinLogger.log(osLogSeverity, throwable.getStackTrace().joinToString("\n"))
     }
 

diff --git a/kermit-core/src/darwinMain/kotlin/co/touchlab/kermit/XcodeSeverityWriter.kt b/kermit-core/src/darwinMain/kotlin/co/touchlab/kermit/XcodeSeverityWriter.kt
@@ -16,7 +16,8 @@ import kotlin.experimental.ExperimentalNativeApi
  * Development-focused LogWriter. Will write a colored emoji according to Severity, and write the Throwable stack trace
  * to println rather than oslog, as oslog will cut off long strings.
  */
-open class XcodeSeverityWriter(private val messageStringFormatter: MessageStringFormatter = DefaultFormatter) : OSLogWriter(messageStringFormatter) {
+open class XcodeSeverityWriter(private val messageStringFormatter: MessageStringFormatter = DefaultFormatter) :
+    OSLogWriter(messageStringFormatter) {
     override fun formatMessage(severity: Severity, tag: Tag, message: Message): String =
         "${emojiPrefix(severity)} ${messageStringFormatter.formatMessage(null, tag, message)}"
 

diff --git a/kermit-core/src/darwinMain/kotlin/co/touchlab/kermit/platformLogWriter.kt b/kermit-core/src/darwinMain/kotlin/co/touchlab/kermit/platformLogWriter.kt
@@ -10,4 +10,5 @@
 
 package co.touchlab.kermit
 
-actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter = XcodeSeverityWriter(messageStringFormatter)
+actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter =
+    XcodeSeverityWriter(messageStringFormatter)
diff --git a/kermit-core/src/jsMain/kotlin/co/touchlab/kermit/ConsoleWriter.kt b/kermit-core/src/jsMain/kotlin/co/touchlab/kermit/ConsoleWriter.kt
@@ -19,7 +19,10 @@ class ConsoleWriter internal constructor(
     private val messageStringFormatter: MessageStringFormatter,
     private val console: ConsoleIntf
 ) : LogWriter() {
-    constructor(messageStringFormatter: MessageStringFormatter = DefaultFormatter) : this(messageStringFormatter, ConsoleActual)
+    constructor(messageStringFormatter: MessageStringFormatter = DefaultFormatter) : this(
+        messageStringFormatter,
+        ConsoleActual
+    )
 
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
         var output = messageStringFormatter.formatMessage(

diff --git a/kermit-core/src/jsTest/kotlin/co/touchlab/kermit/ConsoleWriterTest.kt b/kermit-core/src/jsTest/kotlin/co/touchlab/kermit/ConsoleWriterTest.kt
@@ -41,7 +41,7 @@ class ConsoleWriterTest {
 
 }
 
-class ConsoleCollector: ConsoleIntf {
+class ConsoleCollector : ConsoleIntf {
     val errors = mutableListOf<String>()
     val warnings = mutableListOf<String>()
     val infos = mutableListOf<String>()

diff --git a/kermit-core/src/jvmMain/kotlin/co/touchlab/kermit/platformLogWriter.kt b/kermit-core/src/jvmMain/kotlin/co/touchlab/kermit/platformLogWriter.kt
@@ -10,4 +10,5 @@
 
 package co.touchlab.kermit
 
-actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter = SystemWriter(messageStringFormatter)
+actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter =
+    SystemWriter(messageStringFormatter)
diff --git a/kermit-core/src/linuxMain/kotlin/co/touchlab/kermit/platformLogWriter.kt b/kermit-core/src/linuxMain/kotlin/co/touchlab/kermit/platformLogWriter.kt
@@ -10,4 +10,5 @@
 
 package co.touchlab.kermit
 
-actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter = CommonWriter(messageStringFormatter)
+actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter =
+    CommonWriter(messageStringFormatter)
diff --git a/kermit-core/src/mingwMain/kotlin/co/touchlab/kermit/platformLogWriter.kt b/kermit-core/src/mingwMain/kotlin/co/touchlab/kermit/platformLogWriter.kt
@@ -10,4 +10,5 @@
 
 package co.touchlab.kermit
 
-actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter = CommonWriter(messageStringFormatter)
+actual fun platformLogWriter(messageStringFormatter: MessageStringFormatter): LogWriter =
+    CommonWriter(messageStringFormatter)
diff --git a/kermit-core/src/nativeMain/kotlin/co/touchlab/kermit/KermitConfig.kt b/kermit-core/src/nativeMain/kotlin/co/touchlab/kermit/KermitConfig.kt
@@ -28,4 +28,5 @@ internal class AtomicMutableLoggerConfig(logWriters: List<LogWriter>) : MutableL
         }
 }
 
-actual fun mutableLoggerConfigInit(logWriters: List<LogWriter>): MutableLoggerConfig = AtomicMutableLoggerConfig(logWriters)
+actual fun mutableLoggerConfigInit(logWriters: List<LogWriter>): MutableLoggerConfig =
+    AtomicMutableLoggerConfig(logWriters)
diff --git a/kermit-simple/src/nonKotlinTest/kotlin/co/touchlab/kermit/LoggerExtensionsTest.kt b/kermit-simple/src/nonKotlinTest/kotlin/co/touchlab/kermit/LoggerExtensionsTest.kt
@@ -14,7 +14,7 @@ import kotlin.test.Test
 
 class LoggerExtensionsTest {
     @Test
-    fun testCallingExtensions(){
+    fun testCallingExtensions() {
         /*val testLogWriter = TestLogWriter(Severity.Verbose)
         val log = Logger(loggerConfigInit(testLogWriter))
         log.v("A")*/

diff --git a/kermit/build.gradle.kts b/kermit/build.gradle.kts
@@ -50,7 +50,7 @@ kotlin {
     androidNativeArm64()
     androidNativeX86()
     androidNativeX64()
-    
+
     sourceSets {
         val commonMain by getting {
             dependencies {
@@ -106,7 +106,7 @@ kotlin {
 
             mainSourceSet.dependsOn(nativeMain)
             testSourceSet.dependsOn(nonKotlinTest)
-        }   
+        }
     }
 }
 

diff --git a/kermit/src/commonMain/kotlin/co/touchlab/kermit/Logger.kt b/kermit/src/commonMain/kotlin/co/touchlab/kermit/Logger.kt
@@ -29,62 +29,62 @@ open class Logger(
     }
 
     @JvmOverloads
-    inline fun v(throwable: Throwable? = null, tag: String = this.tag, message: () -> String){
+    inline fun v(throwable: Throwable? = null, tag: String = this.tag, message: () -> String) {
         logBlock(Severity.Verbose, tag, throwable, message)
     }
 
     @JvmOverloads
-    inline fun d(throwable: Throwable? = null, tag: String = this.tag, message: () -> String){
+    inline fun d(throwable: Throwable? = null, tag: String = this.tag, message: () -> String) {
         logBlock(Severity.Debug, tag, throwable, message)
     }
 
     @JvmOverloads
-    inline fun i(throwable: Throwable? = null, tag: String = this.tag, message: () -> String){
+    inline fun i(throwable: Throwable? = null, tag: String = this.tag, message: () -> String) {
         logBlock(Severity.Info, tag, throwable, message)
     }
 
     @JvmOverloads
-    inline fun w(throwable: Throwable? = null, tag: String = this.tag, message: () -> String){
+    inline fun w(throwable: Throwable? = null, tag: String = this.tag, message: () -> String) {
         logBlock(Severity.Warn, tag, throwable, message)
     }
 
     @JvmOverloads
-    inline fun e(throwable: Throwable? = null, tag: String = this.tag, message: () -> String){
+    inline fun e(throwable: Throwable? = null, tag: String = this.tag, message: () -> String) {
         logBlock(Severity.Error, tag, throwable, message)
     }
 
     @JvmOverloads
-    inline fun a(throwable: Throwable? = null, tag: String = this.tag, message: () -> String){
+    inline fun a(throwable: Throwable? = null, tag: String = this.tag, message: () -> String) {
         logBlock(Severity.Assert, tag, throwable, message)
     }
 
     @JvmOverloads
-    inline fun v(messageString: String, throwable: Throwable? = null, tag: String = this.tag){
+    inline fun v(messageString: String, throwable: Throwable? = null, tag: String = this.tag) {
         log(Severity.Verbose, tag, throwable, messageString)
     }
 
     @JvmOverloads
-    inline fun d(messageString: String, throwable: Throwable? = null, tag: String = this.tag){
+    inline fun d(messageString: String, throwable: Throwable? = null, tag: String = this.tag) {
         log(Severity.Debug, tag, throwable, messageString)
     }
 
     @JvmOverloads
-    inline fun i(messageString: String, throwable: Throwable? = null, tag: String = this.tag){
+    inline fun i(messageString: String, throwable: Throwable? = null, tag: String = this.tag) {
         log(Severity.Info, tag, throwable, messageString)
     }
 
     @JvmOverloads
-    inline fun w(messageString: String, throwable: Throwable? = null, tag: String = this.tag){
+    inline fun w(messageString: String, throwable: Throwable? = null, tag: String = this.tag) {
         log(Severity.Warn, tag, throwable, messageString)
     }
 
     @JvmOverloads
-    inline fun e(messageString: String, throwable: Throwable? = null, tag: String = this.tag){
+    inline fun e(messageString: String, throwable: Throwable? = null, tag: String = this.tag) {
         log(Severity.Error, tag, throwable, messageString)
     }
 
     @JvmOverloads
-    inline fun a(messageString: String, throwable: Throwable? = null, tag: String = this.tag){
+    inline fun a(messageString: String, throwable: Throwable? = null, tag: String = this.tag) {
         log(Severity.Assert, tag, throwable, messageString)
     }
 

diff --git a/kermit/src/commonTest/kotlin/co/touchlab/kermit/LoggerTest.kt b/kermit/src/commonTest/kotlin/co/touchlab/kermit/LoggerTest.kt
@@ -315,6 +315,6 @@ object MyLogger : Logger(
     tag = "MyAppTag"
 )
 
-fun hello(){
+fun hello() {
     MyLogger.i { "Hello" }
 }