Remove unused functions from tooling API (#7159)

* Remove unused functions * Add note about tooling clients
detekt · Apr 10, 2024 · 527de6f · 527de6f
1 parent 84314be
commit 527de6f
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 14 deletions.
diff --git a/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/tooling/AnalysisFacade.kt b/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/tooling/AnalysisFacade.kt
@@ -14,7 +14,6 @@ import io.gitlab.arturbosch.detekt.core.ProcessingSettings
 import io.gitlab.arturbosch.detekt.core.config.check
 import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.resolve.BindingContext
-import java.nio.file.Path
 import kotlin.io.path.Path
 
 class AnalysisFacade(
@@ -25,9 +24,6 @@ class AnalysisFacade(
         DefaultLifecycle(spec.getDefaultConfiguration(), it, inputPathsToKtFiles)
     }
 
-    override fun run(path: Path): AnalysisResult =
-        runAnalysis { DefaultLifecycle(spec.getDefaultConfiguration(), it, pathToKtFile(path)) }
-
     override fun run(sourceCode: String, filename: String): AnalysisResult =
         runAnalysis {
             DefaultLifecycle(spec.getDefaultConfiguration(), it, contentToKtFile(sourceCode, Path(filename)))

diff --git a/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/tooling/ParsingStrategy.kt b/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/tooling/ParsingStrategy.kt
@@ -15,12 +15,6 @@ fun contentToKtFile(content: String, path: Path): ParsingStrategy = { settings -
     )
 }
 
-fun pathToKtFile(path: Path): ParsingStrategy = { settings ->
-    listOf(
-        KtCompiler(settings.environment).compile(settings.spec.projectSpec.basePath, path)
-    )
-}
-
 val inputPathsToKtFiles: ParsingStrategy = { settings ->
     val compiler = KtCompiler(settings.environment)
     val basePath = settings.spec.projectSpec.basePath

diff --git a/detekt-tooling/api/detekt-tooling.api b/detekt-tooling/api/detekt-tooling.api
@@ -36,7 +36,6 @@ public final class io/github/detekt/tooling/api/DefaultConfigurationProvider$Com
 public abstract interface class io/github/detekt/tooling/api/Detekt {
 	public abstract fun run ()Lio/github/detekt/tooling/api/AnalysisResult;
 	public abstract fun run (Ljava/lang/String;Ljava/lang/String;)Lio/github/detekt/tooling/api/AnalysisResult;
-	public abstract fun run (Ljava/nio/file/Path;)Lio/github/detekt/tooling/api/AnalysisResult;
 	public abstract fun run (Ljava/util/Collection;Lorg/jetbrains/kotlin/resolve/BindingContext;)Lio/github/detekt/tooling/api/AnalysisResult;
 }
 

diff --git a/detekt-tooling/src/main/kotlin/io/github/detekt/tooling/api/Detekt.kt b/detekt-tooling/src/main/kotlin/io/github/detekt/tooling/api/Detekt.kt
@@ -2,7 +2,6 @@ package io.github.detekt.tooling.api
 
 import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.resolve.BindingContext
-import java.nio.file.Path
 
 /**
  * Instance of detekt.
@@ -11,11 +10,12 @@ import java.nio.file.Path
  */
 interface Detekt {
 
+    // Used by detekt-cli
     fun run(): AnalysisResult
 
-    fun run(path: Path): AnalysisResult
-
+    // Used by detekt-intellij-plugin
     fun run(sourceCode: String, filename: String): AnalysisResult
 
+    // Used by detekt-compiler-plugin
     fun run(files: Collection<KtFile>, bindingContext: BindingContext): AnalysisResult
 }