Remove ability to create AnalysisResult by passing source code and fi…

…lename (#7255) * Remove ability to create AnalysisResult by passing source code and filename Calling detekt from production code should only ever pass a KtFile or a Path (from which a KtFile can be created). Creating KtFile from text directly is only required from tests. * Move createKtFile to KtTestCompiler * Remove unused function
detekt · May 7, 2024 · f1b1bb1 · f1b1bb1
1 parent 5b83dc3
commit f1b1bb1
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 30 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 kotlin.io.path.Path
 
 class AnalysisFacade(
     private val spec: ProcessingSpec
@@ -24,11 +23,6 @@ class AnalysisFacade(
         DefaultLifecycle(spec.getDefaultConfiguration(), it, inputPathsToKtFiles)
     }
 
-    override fun run(sourceCode: String, filename: String): AnalysisResult =
-        runAnalysis {
-            DefaultLifecycle(spec.getDefaultConfiguration(), it, contentToKtFile(sourceCode, Path(filename)))
-        }
-
     override fun run(files: Collection<KtFile>, bindingContext: BindingContext): AnalysisResult =
         runAnalysis {
             DefaultLifecycle(

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
@@ -3,18 +3,9 @@ package io.gitlab.arturbosch.detekt.core.tooling
 import io.github.detekt.parser.KtCompiler
 import io.gitlab.arturbosch.detekt.core.ProcessingSettings
 import org.jetbrains.kotlin.psi.KtFile
-import java.nio.file.Path
-import kotlin.io.path.isRegularFile
 
 typealias ParsingStrategy = (settings: ProcessingSettings) -> List<KtFile>
 
-fun contentToKtFile(content: String, path: Path): ParsingStrategy = { settings ->
-    require(path.isRegularFile()) { "Given sub path ($path) should be a regular file!" }
-    listOf(
-        KtCompiler(settings.environment).createKtFile(content, path)
-    )
-}
-
 val inputPathsToKtFiles: ParsingStrategy = { settings ->
     val compiler = KtCompiler(settings.environment)
     settings.spec.projectSpec.inputPaths.map { path ->

diff --git a/detekt-parser/src/main/kotlin/io/github/detekt/parser/KtCompiler.kt b/detekt-parser/src/main/kotlin/io/github/detekt/parser/KtCompiler.kt
@@ -1,21 +1,15 @@
 package io.github.detekt.parser
 
-import org.intellij.lang.annotations.Language
 import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
-import org.jetbrains.kotlin.com.intellij.openapi.util.text.StringUtilRt
 import org.jetbrains.kotlin.com.intellij.psi.util.PsiUtilCore
 import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.psi.KtPsiFactory
 import java.nio.file.Path
 import kotlin.io.path.isRegularFile
-import kotlin.io.path.name
 
 open class KtCompiler(
     protected val environment: KotlinCoreEnvironment = createKotlinCoreEnvironment(printStream = System.err)
 ) {
 
-    protected val psiFileFactory = KtPsiFactory(environment.project, markGenerated = false)
-
     fun compile(path: Path): KtFile {
         require(path.isRegularFile()) { "Given path '$path' should be a regular file!" }
 
@@ -24,7 +18,4 @@ open class KtCompiler(
             "$path is not a Kotlin file"
         }
     }
-
-    fun createKtFile(@Language("kotlin") content: String, path: Path): KtFile =
-        psiFileFactory.createPhysicalFile(path.name, StringUtilRt.convertLineSeparators(content))
 }
diff --git a/detekt-test-utils/src/main/kotlin/io/github/detekt/test/utils/KtTestCompiler.kt b/detekt-test-utils/src/main/kotlin/io/github/detekt/test/utils/KtTestCompiler.kt
@@ -2,6 +2,7 @@ package io.github.detekt.test.utils
 
 import io.github.detekt.parser.KtCompiler
 import kotlinx.coroutines.CoroutineScope
+import org.intellij.lang.annotations.Language
 import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys
 import org.jetbrains.kotlin.cli.common.messages.MessageCollector
 import org.jetbrains.kotlin.cli.jvm.compiler.EnvironmentConfigFiles
@@ -10,18 +11,24 @@ import org.jetbrains.kotlin.cli.jvm.config.addJavaSourceRoots
 import org.jetbrains.kotlin.cli.jvm.config.addJvmClasspathRoot
 import org.jetbrains.kotlin.cli.jvm.config.addJvmClasspathRoots
 import org.jetbrains.kotlin.cli.jvm.config.configureJdkClasspathRoots
-import org.jetbrains.kotlin.com.intellij.openapi.project.Project
 import org.jetbrains.kotlin.com.intellij.openapi.util.Disposer
+import org.jetbrains.kotlin.com.intellij.openapi.util.text.StringUtilRt
 import org.jetbrains.kotlin.config.CommonConfigurationKeys
 import org.jetbrains.kotlin.config.CompilerConfiguration
 import org.jetbrains.kotlin.config.JVMConfigurationKeys
+import org.jetbrains.kotlin.psi.KtFile
+import org.jetbrains.kotlin.psi.KtPsiFactory
 import java.io.File
+import java.nio.file.Path
+import kotlin.io.path.name
 
 /**
  * Test compiler extends kt compiler and adds ability to compile from text content.
  */
 internal object KtTestCompiler : KtCompiler() {
 
+    private val psiFileFactory = KtPsiFactory(environment.project, markGenerated = false)
+
     /**
      * Not sure why but this function only works from this context.
      * Somehow the Kotlin language was not yet initialized.
@@ -55,7 +62,8 @@ internal object KtTestCompiler : KtCompiler() {
         return KotlinCoreEnvironmentWrapper(kotlinCoreEnvironment, parentDisposable)
     }
 
-    fun project(): Project = environment.project
+    fun createKtFile(@Language("kotlin") content: String, path: Path): KtFile =
+        psiFileFactory.createPhysicalFile(path.name, StringUtilRt.convertLineSeparators(content))
 
     private fun kotlinStdLibPath(): File {
         return File(CharRange::class.java.protectionDomain.codeSource.location.path)

diff --git a/detekt-tooling/api/detekt-tooling.api b/detekt-tooling/api/detekt-tooling.api
@@ -35,7 +35,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/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
@@ -13,9 +13,6 @@ interface Detekt {
     // Used by detekt-cli
     fun run(): 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
 }