#1 Consistent line length enforcement by Spotless & Ktlint

klogging · Jul 6, 2023 · 91fa7b4 · 91fa7b4
1 parent 846acb0
commit 91fa7b4
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 29 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,2 @@
+[*.{kt,kts}]
+max_line_length = 100
diff --git a/buildSrc/src/main/kotlin/io/klogging/build/SpotlessConfiguration.kt b/buildSrc/src/main/kotlin/io/klogging/build/SpotlessConfiguration.kt
@@ -51,53 +51,36 @@ fun Project.configureSpotless(ktlintVersion: String) {
 
     configure<SpotlessExtension> {
         format("markdown") {
-            target(
-                fileTree(
-                    mapOf(
-                        "dir" to ".",
-                        "include" to listOf("**/*.md"),
-                        "exclude" to listOf(".gradle/**", ".gradle-cache/**", ".batect/**", "build/**")
-                    )
-                )
-            )
-
+            target("**/*.md")
+            targetExclude(".gradle/**", ".gradle-cache/**", ".batect/**", "build/**")
             indentWithSpaces()
             endWithNewline()
         }
 
         format("misc") {
-            target(
-                fileTree(
-                    mapOf(
-                        "dir" to ".",
-                        "include" to listOf("**/.gitignore", "**/*.yaml", "**/*.yml", "**/*.sh", "**/Dockerfile"),
-                        "exclude" to listOf("**/*.md", ".gradle/**", ".gradle-cache/**", ".batect/**", "build/**")
-                    )
-                )
-            )
-
+            target("**/.gitignore", "**/*.yaml", "**/*.yml", "**/*.sh", "**/Dockerfile")
+            targetExclude("**/*.md", ".gradle/**", ".gradle-cache/**", ".batect/**", "build/**")
             trimTrailingWhitespace()
             indentWithSpaces()
             endWithNewline()
         }
 
         kotlinGradle {
-            target("*.gradle.kts", "gradle/*.gradle.kts", "buildSrc/*.gradle.kts")
+            target("*.gradle.kts", "gradle/*.gradle.kts", "buildSrc/*.gradle.kts", "buildSrc/**/*.kt")
             ktlint(ktlintVersion)
+                .editorConfigOverride(mapOf("max_line_length" to "off"))
 
-            @Suppress("INACCESSIBLE_TYPE")
-            licenseHeader(kotlinLicenceHeader, "import|tasks|apply|plugins|rootProject|dependencyResolutionManagement")
+            licenseHeader(kotlinLicenceHeader, "package|import|tasks|apply|plugins|rootProject|dependencyResolutionManagement")
 
             trimTrailingWhitespace()
             indentWithSpaces()
             endWithNewline()
         }
 
         kotlin {
-            target("src/**/*.kt", "buildSrc/**/*.kt")
+            target("src/**/*.kt")
             ktlint(ktlintVersion)
 
-            @Suppress("INACCESSIBLE_TYPE")
             licenseHeader(kotlinLicenceHeader)
 
             trimTrailingWhitespace()
@@ -108,7 +91,6 @@ fun Project.configureSpotless(ktlintVersion: String) {
         java {
             target("src/**/*.java")
 
-            @Suppress("INACCESSIBLE_TYPE")
             licenseHeader(kotlinLicenceHeader)
 
             trimTrailingWhitespace()

diff --git a/src/main/kotlin/io/klogging/slf4j/NoCoLoggerWrapper.kt b/src/main/kotlin/io/klogging/slf4j/NoCoLoggerWrapper.kt
@@ -178,7 +178,12 @@ public class NoCoLoggerWrapper(
      * Forward an event and exception with context items from [MDC], handling null [format] and
      * absence of [arguments].
      */
-    private fun emitEvent(level: Level, throwable: Throwable?, format: String? = null, vararg arguments: Any?) {
+    private fun emitEvent(
+        level: Level,
+        throwable: Throwable?,
+        format: String? = null,
+        vararg arguments: Any?
+    ) {
         val formatted = MessageFormatter.arrayFormat(format, arguments).message
         if (format == null || arguments.isEmpty()) {
             noCoLogger.emitEvent(level, throwable, formatted, contextItems())

diff --git a/src/test/kotlin/io/klogging/slf4j/NoCoLoggerWrapperTest.kt b/src/test/kotlin/io/klogging/slf4j/NoCoLoggerWrapperTest.kt
@@ -149,7 +149,12 @@ class NoCoLoggerWrapperTest : DescribeSpec({
                 val id = randomString()
                 val name = randomString()
                 val age = Random.nextInt(50)
-                LoggerFactory.getLogger(randomString()).info("User {id} called {name} is {age}", id, name, age)
+                LoggerFactory.getLogger(randomString()).info(
+                    "User {id} called {name} is {age}",
+                    id,
+                    name,
+                    age
+                )
                 waitForDispatch()
 
                 saved shouldHaveSize 1
@@ -224,7 +229,10 @@ class NoCoLoggerWrapperTest : DescribeSpec({
 
         it("passes `Throwable` object") {
             val saved = savedEvents()
-            LoggerFactory.getLogger(randomString()).warn(randomString(), java.lang.RuntimeException(randomString()))
+            LoggerFactory.getLogger(randomString()).warn(
+                randomString(),
+                java.lang.RuntimeException(randomString())
+            )
             waitForDispatch()
 
             saved shouldHaveSize 1