Improvements to configurable source exclusions following review

fwcd · Feb 4, 2025 · 50325f6 · 50325f6
1 parent addcef3
commit 50325f6
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 10 deletions.
diff --git a/server/src/main/kotlin/org/javacs/kt/KotlinWorkspaceService.kt b/server/src/main/kotlin/org/javacs/kt/KotlinWorkspaceService.kt
@@ -192,7 +192,7 @@ class KotlinWorkspaceService(
             // Update source file exclusions
             get("exclusions")?.asJsonObject?.apply {
                 val exclusions = config.exclusions
-                get("excludePatterns")?.asString?.let { exclusions.excludePatterns = it }
+                get("excludePatterns")?.asJsonArray?.let { exclusions.excludePatterns = it.asList().map { it.asString } }
                 sf.updateExclusions()
             }
         }

diff --git a/shared/src/main/kotlin/org/javacs/kt/ExclusionsConfiguration.kt b/shared/src/main/kotlin/org/javacs/kt/ExclusionsConfiguration.kt
@@ -1,5 +1,5 @@
 package org.javacs.kt
 
 data class ExclusionsConfiguration(
-    var excludePatterns: String = "", // Semicolon-separated list of glob patterns
+    var excludePatterns: List<String> = listOf(), // Semicolon-separated list of glob patterns
 )
diff --git a/shared/src/main/kotlin/org/javacs/kt/SourceExclusions.kt b/shared/src/main/kotlin/org/javacs/kt/SourceExclusions.kt
@@ -14,7 +14,7 @@ class SourceExclusions(
     private val scriptsConfig: ScriptsConfiguration,
     private val exclusionsConfig: ExclusionsConfiguration,
 ) {
-    val configuredExclusions = exclusionsConfig.excludePatterns.split(";").map { it.trim() }.filter { it.isNotEmpty() }
+    val configuredExclusions = exclusionsConfig.excludePatterns.map { it.trim() }.filter { it.isNotEmpty() }
     val excludedPatterns = listOf(
         ".git", ".hg", ".svn",                                                      // Version control systems
         ".idea", ".idea_modules", ".vs", ".vscode", ".code-workspace", ".settings", // IDEs
@@ -30,6 +30,7 @@ class SourceExclusions(
         .filterNotNull()
 
     private fun parseExcludePattern(pattern: String): PathMatcher? {
+        fun warning(e: Exception) = LOG.warn("Did not recognize exclude pattern: '$pattern' (${e.message})")
         try {
             val normalizedPattern = pattern.removeSuffix("/").trim()
             val pathMatcher =
@@ -41,11 +42,11 @@ class SourceExclusions(
                 }
             return pathMatcher
         } catch (e: IllegalArgumentException) {
-            LOG.warn("Did not recognize exclude pattern: '{}' ({})", pattern, e.message)
+            warning(e)
         } catch (e: PatternSyntaxException) {
-            LOG.warn("Did not recognize exclude pattern: '{}' ({})", pattern, e.message)
+            warning(e)
         } catch (e: UnsupportedOperationException) {
-            LOG.warn("Did not recognize exclude pattern: '{}' ({})", pattern, e.message)
+            warning(e)
         }
         return null
     }

diff --git a/shared/src/test/kotlin/org/javacs/kt/SourceExclusionsTest.kt b/shared/src/test/kotlin/org/javacs/kt/SourceExclusionsTest.kt
@@ -13,7 +13,7 @@ import org.junit.Test
 
 class SourceExclusionsTest {
     private val workspaceRoots = listOf(File("/test/workspace1").toPath(), File("/test/workspace2").toPath())
-    private var excludePatterns = ""
+    private var excludePatterns = listOf<String>()
 
     @Test
     fun `test only default exclusions`() {
@@ -25,23 +25,23 @@ class SourceExclusionsTest {
 
     @Test
     fun `test configured exclusions`() {
-        excludePatterns = "build;junk"
+        excludePatterns = listOf("build","junk")
         assertIncluded("/test/workspace1/src/main/kotlin/MyClass.kt")
         assertExcluded("/test/workspace1/build/generated/blah.kt")
         assertExcluded("/test/workspace1/src/main/kotlin/junk/blah.kt")
     }
 
     @Test
     fun `test configured directory exclusions`() {
-        excludePatterns = "build/dist/**"
+        excludePatterns = listOf("build/dist/**")
         assertIncluded("/test/workspace1/build/generated/blah.kt")
         assertIncluded("/test/workspace1/blah/build/dist/blah.kt")
         assertExcluded("/test/workspace1/build/dist/blah.kt")
     }
 
     @Test
     fun `test configured wildcard directory exclusions`() {
-        excludePatterns = "**/build/dist/**;build/dist/**"
+        excludePatterns = listOf("**/build/dist/**", "build/dist/**")
         assertIncluded("/test/workspace1/build/generated/blah.kt")
         assertExcluded("/test/workspace1/blah/build/dist/blah.kt")
         assertExcluded("/test/workspace1/build/dist/blah.kt")