Merge pull request #536 from fwcd/disable-kts

Disable support for Kotlin scripts by default and add corresponding configuration options

Author: fwcd

detekt.yml

@@ -3,10 +3,10 @@ config:
   warningsAsErrors: false
 
 comments:
-  excludes: ["**/src/test/resources/**"]
+  excludes: ["**/src/test/**"]
 
 complexity:
-  excludes: ["**/src/test/resources/**"]
+  excludes: ["**/src/test/**"]
 
 empty-blocks:
   excludes: ["**/src/test/**"]

server/src/main/kotlin/org/javacs/kt/CompilerClassPath.kt

@@ -15,7 +15,11 @@ import java.nio.file.Path
  * Manages the class path (compiled JARs, etc), the Java source path
  * and the compiler. Note that Kotlin sources are stored in SourcePath.
  */
-class CompilerClassPath(private val config: CompilerConfiguration, private val databaseService: DatabaseService) : Closeable {
+class CompilerClassPath(
+    private val config: CompilerConfiguration,
+    private val scriptsConfig: ScriptsConfiguration,
+    private val databaseService: DatabaseService
+) : Closeable {
     val workspaceRoots = mutableSetOf<Path>()
 
     private val javaSourcePath = mutableSetOf<Path>()
@@ -24,7 +28,13 @@ class CompilerClassPath(private val config: CompilerConfiguration, private val d
     val outputDirectory: File = Files.createTempDirectory("klsBuildOutput").toFile()
     val javaHome: String? = System.getProperty("java.home", null)
 
-    var compiler = Compiler(javaSourcePath, classPath.map { it.compiledJar }.toSet(), buildScriptClassPath, outputDirectory)
+    var compiler = Compiler(
+        javaSourcePath,
+        classPath.map { it.compiledJar }.toSet(),
+        buildScriptClassPath,
+        scriptsConfig,
+        outputDirectory
+    )
         private set
 
     private val async = AsyncExecutor()
@@ -72,7 +82,13 @@ class CompilerClassPath(private val config: CompilerConfiguration, private val d
         if (refreshCompiler) {
             LOG.info("Reinstantiating compiler")
             compiler.close()
-            compiler = Compiler(javaSourcePath, classPath.map { it.compiledJar }.toSet(), buildScriptClassPath, outputDirectory)
+            compiler = Compiler(
+                javaSourcePath,
+                classPath.map { it.compiledJar }.toSet(),
+                buildScriptClassPath,
+                scriptsConfig,
+                outputDirectory
+            )
             updateCompilerConfiguration()
         }
 

server/src/main/kotlin/org/javacs/kt/Configuration.kt

@@ -30,6 +30,13 @@ public data class DiagnosticsConfiguration(
     var debounceTime: Long = 250L
 )
 
+public data class ScriptsConfiguration(
+    /** Whether .kts scripts are handled. */
+    var enabled: Boolean = false,
+    /** Whether .gradle.kts scripts are handled. Only considered if scripts are enabled in general. */
+    var buildScriptsEnabled: Boolean = false
+)
+
 public data class JVMConfiguration(
     /** Which JVM target the Kotlin compiler uses. See Compiler.jvmTargetFrom for possible values. */
     var target: String = "default"
@@ -91,7 +98,8 @@ public data class Configuration(
     val compiler: CompilerConfiguration = CompilerConfiguration(),
     val completion: CompletionConfiguration = CompletionConfiguration(),
     val diagnostics: DiagnosticsConfiguration = DiagnosticsConfiguration(),
-    var indexing: IndexingConfiguration = IndexingConfiguration(),
+    val scripts: ScriptsConfiguration = ScriptsConfiguration(),
+    val indexing: IndexingConfiguration = IndexingConfiguration(),
     val externalSources: ExternalSourcesConfiguration = ExternalSourcesConfiguration(),
     val hints: InlayHintsConfiguration = InlayHintsConfiguration()
 )

server/src/main/kotlin/org/javacs/kt/KotlinLanguageServer.kt

@@ -22,15 +22,16 @@ import java.nio.file.Paths
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.CompletableFuture.completedFuture
 
-class KotlinLanguageServer : LanguageServer, LanguageClientAware, Closeable {
-    val config = Configuration()
+class KotlinLanguageServer(
+    val config: Configuration = Configuration()
+) : LanguageServer, LanguageClientAware, Closeable {
     val databaseService = DatabaseService()
-    val classPath = CompilerClassPath(config.compiler, databaseService)
+    val classPath = CompilerClassPath(config.compiler, config.scripts, databaseService)
 
     private val tempDirectory = TemporaryDirectory()
     private val uriContentProvider = URIContentProvider(ClassContentProvider(config.externalSources, classPath, tempDirectory, CompositeSourceArchiveProvider(JdkSourceArchiveProvider(classPath), ClassPathSourceArchiveProvider(classPath))))
     val sourcePath = SourcePath(classPath, uriContentProvider, config.indexing, databaseService)
-    val sourceFiles = SourceFiles(sourcePath, uriContentProvider)
+    val sourceFiles = SourceFiles(sourcePath, uriContentProvider, config.scripts)
 
     private val textDocuments = KotlinTextDocumentService(sourceFiles, sourcePath, config, tempDirectory, uriContentProvider, classPath)
     private val workspaces = KotlinWorkspaceService(sourceFiles, sourcePath, classPath, textDocuments, config)

server/src/main/kotlin/org/javacs/kt/KotlinWorkspaceService.kt

@@ -135,6 +135,13 @@ class KotlinWorkspaceService(
                 }
             }
 
+            // Update scripts options
+            get("scripts")?.asJsonObject?.apply {
+                val scripts = config.scripts
+                get("enabled")?.asBoolean?.let { scripts.enabled = it }
+                get("buildScriptsEnabled")?.asBoolean?.let { scripts.buildScriptsEnabled = it }
+            }
+
             // Update code-completion options
             get("completion")?.asJsonObject?.apply {
                 val completion = config.completion

server/src/main/kotlin/org/javacs/kt/SourceFiles.kt

@@ -65,7 +65,8 @@ private class NotifySourcePath(private val sp: SourcePath) {
  */
 class SourceFiles(
     private val sp: SourcePath,
-    private val contentProvider: URIContentProvider
+    private val contentProvider: URIContentProvider,
+    private val scriptsConfig: ScriptsConfiguration
 ) {
     private val workspaceRoots = mutableSetOf<Path>()
     private var exclusions = SourceExclusions(workspaceRoots)
@@ -175,6 +176,19 @@ class SourceFiles(
         updateExclusions()
     }
 
+    private fun findSourceFiles(root: Path): Set<URI> {
+        val glob = if (scriptsConfig.enabled) "*.{kt,kts}" else "*.kt"
+        val sourceMatcher = FileSystems.getDefault().getPathMatcher("glob:$glob")
+        return SourceExclusions(root)
+            .walkIncluded()
+            .filter {
+                sourceMatcher.matches(it.fileName)
+                && (scriptsConfig.buildScriptsEnabled || !it.endsWith(".gradle.kts"))
+            }
+            .map(Path::toUri)
+            .toSet()
+    }
+
     private fun updateExclusions() {
         exclusions = SourceExclusions(workspaceRoots)
     }
@@ -222,15 +236,6 @@ private fun patch(sourceText: String, change: TextDocumentContentChangeEvent): S
     }
 }
 
-private fun findSourceFiles(root: Path): Set<URI> {
-    val sourceMatcher = FileSystems.getDefault().getPathMatcher("glob:*.{kt,kts}")
-    return SourceExclusions(root)
-        .walkIncluded()
-        .filter { sourceMatcher.matches(it.fileName) }
-        .map(Path::toUri)
-        .toSet()
-}
-
 private fun logAdded(sources: Collection<URI>, rootPath: Path?) {
     LOG.info("Adding {} under {} to source path", describeURIs(sources), rootPath)
 }