Require basePath when setting up environment

This is a prerequisite for fixing detekt#3728
3flex · Jul 29, 2023 · 342872e · 342872e
1 parent 51e6065
commit 342872e
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/CliArgs.kt b/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/CliArgs.kt
@@ -4,6 +4,7 @@ import com.beust.jcommander.Parameter
 import org.jetbrains.kotlin.config.JvmTarget
 import org.jetbrains.kotlin.config.LanguageVersion
 import java.nio.file.Path
+import kotlin.io.path.Path
 
 class CliArgs {
 
@@ -92,7 +93,7 @@ class CliArgs {
             "File paths in console output and txt report are not affected and remain as absolute paths.",
         converter = PathConverter::class
     )
-    var basePath: Path? = null
+    var basePath: Path = Path(System.getProperty("user.dir"))
 
     @Parameter(
         names = ["--disable-default-rulesets", "-dd"],

diff --git a/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/KtTreeCompiler.kt b/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/KtTreeCompiler.kt
@@ -18,7 +18,7 @@ class KtTreeCompiler(
     private val compiler: KtCompiler = KtCompiler(settings.environment)
 ) {
 
-    private val basePath: Path? = projectSpec.basePath
+    private val basePath: Path = projectSpec.basePath
     private val pathFilters: PathFilters? =
         PathFilters.of(projectSpec.includes.toList(), projectSpec.excludes.toList())
 

diff --git a/.../src/main/kotlin/io/gitlab/arturbosch/detekt/core/tooling/ProcessingSpecSettingsBridge.kt b/.../src/main/kotlin/io/gitlab/arturbosch/detekt/core/tooling/ProcessingSpecSettingsBridge.kt
@@ -20,7 +20,7 @@ internal fun <R> ProcessingSpec.withSettings(execute: ProcessingSettings.() -> R
             register(DETEKT_BASELINE_CREATION_KEY, baselineSpec.shouldCreateDuringAnalysis)
             register(MONITOR_PROPERTY_KEY, monitor)
             register(DETEKT_OUTPUT_REPORT_PATHS_KEY, reportsSpec.reports)
-            projectSpec.basePath?.let { register(DETEKT_OUTPUT_REPORT_BASE_PATH_KEY, it) }
+            register(DETEKT_OUTPUT_REPORT_BASE_PATH_KEY, projectSpec.basePath)
         }
     }
     val result = settings.use { execute(it) }

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
@@ -20,13 +20,13 @@ open class KtCompiler(
 
     protected val psiFileFactory = KtPsiFactory(environment.project, markGenerated = false)
 
-    fun compile(basePath: Path?, path: Path): KtFile {
+    fun compile(basePath: Path, path: Path): KtFile {
         require(path.isRegularFile()) { "Given sub path ($path) should be a regular file!" }
         val content = path.readText()
         return createKtFile(content, basePath, path)
     }
 
-    fun createKtFile(content: String, basePath: Path?, path: Path): KtFile {
+    fun createKtFile(content: String, basePath: Path, path: Path): KtFile {
         require(path.isRegularFile()) { "Given sub path ($path) should be a regular file!" }
 
         val normalizedAbsolutePath = path.absolute().normalize()
@@ -40,11 +40,9 @@ open class KtCompiler(
         return psiFile.apply {
             this.absolutePath = normalizedAbsolutePath
             this.lineSeparator = lineSeparator
-            val normalizedBasePath = basePath?.absolute()?.normalize()
-            normalizedBasePath?.relativize(normalizedAbsolutePath)?.let { relativePath ->
-                this.basePath = normalizedBasePath.absolute()
-                this.relativePath = relativePath
-            }
+            val normalizedBasePath = basePath.absolute().normalize()
+            this.basePath = normalizedBasePath.absolute()
+            this.relativePath = normalizedBasePath.relativize(normalizedAbsolutePath)
         }
     }
 }

diff --git a/detekt-tooling/src/main/kotlin/io/github/detekt/tooling/api/spec/ProjectSpec.kt b/detekt-tooling/src/main/kotlin/io/github/detekt/tooling/api/spec/ProjectSpec.kt
@@ -10,7 +10,7 @@ interface ProjectSpec {
     /**
      * A base path to relativize paths. Mostly used for generating path in the output or report.
      */
-    val basePath: Path?
+    val basePath: Path
 
     /**
      * Paths to analyze. Works with files and directories.

diff --git a/detekt-tooling/src/main/kotlin/io/github/detekt/tooling/dsl/ProjectSpecBuilder.kt b/detekt-tooling/src/main/kotlin/io/github/detekt/tooling/dsl/ProjectSpecBuilder.kt
@@ -2,11 +2,12 @@ package io.github.detekt.tooling.dsl
 
 import io.github.detekt.tooling.api.spec.ProjectSpec
 import java.nio.file.Path
+import kotlin.io.path.Path
 
 @ProcessingModelDsl
 class ProjectSpecBuilder : Builder<ProjectSpec> {
 
-    var basePath: Path? = null
+    var basePath: Path = Path("")
     var inputPaths: Collection<Path> = emptyList()
     var excludes: Collection<String> = emptyList()
     var includes: Collection<String> = emptyList()
@@ -15,7 +16,7 @@ class ProjectSpecBuilder : Builder<ProjectSpec> {
 }
 
 private data class ProjectModel(
-    override val basePath: Path?,
+    override val basePath: Path,
     override val inputPaths: Collection<Path>,
     override val excludes: Collection<String>,
     override val includes: Collection<String>