Remove PsiFile.lineSeparator (#7240)

* Use built-in functions to store & retrieve detected line separator

detekt only needs to set this itself when compiling KtFile directly.
When other methods are used to create KtFiles the line separator is
automatically set.

* Remove PsiFile.lineSeparator

* Add line ending tests for autocorrect

* Trigger automatic line separator detection in tests

This is required when loading KtFile using standard methods

detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/runners/RunnerSpec.kt

@@ -286,5 +286,35 @@ class RunnerSpec {
                 """.trimIndent()
             )
         }
+
+        @Test
+        fun `keeps LF line endings after autocorrect`() {
+            val inputPath = resourceAsPath("/autocorrect/SingleRuleLF.kt")
+
+            assertThatThrownBy {
+                Runner(parseArguments(args + inputPath.toString()), outPrintStream, errPrintStream).execute()
+            }.isInstanceOf(IssuesFound::class.java)
+
+            assertThat(errPrintStream.toString()).isEmpty()
+            assertThat(outPrintStream.toString())
+                .contains("${inputPath.absolutePathString()}:3:1: Needless blank line(s) [NoConsecutiveBlankLines]")
+                .contains("$modificationMessagePrefix${inputPath.absolutePathString()}$modificationMessageSuffix")
+            assertThat(inputPath).content().isEqualTo("class Test {\n\n}\n")
+        }
+
+        @Test
+        fun `keeps CRLF line endings after autocorrect`() {
+            val inputPath = resourceAsPath("/autocorrect/SingleRuleCRLF.kt")
+
+            assertThatThrownBy {
+                Runner(parseArguments(args + inputPath.toString()), outPrintStream, errPrintStream).execute()
+            }.isInstanceOf(IssuesFound::class.java)
+
+            assertThat(errPrintStream.toString()).isEmpty()
+            assertThat(outPrintStream.toString())
+                .contains("${inputPath.absolutePathString()}:3:1: Needless blank line(s) [NoConsecutiveBlankLines]")
+                .contains("$modificationMessagePrefix${inputPath.absolutePathString()}$modificationMessageSuffix")
+            assertThat(inputPath).content().isEqualTo("class Test {\r\n\r\n}\r\n")
+        }
     }
 }

detekt-cli/src/test/resources/autocorrect/.gitattributes

@@ -0,0 +1,2 @@
+SingleRuleLF.kt   text eol=lf
+SingleRuleCRLF.kt text eol=crlf

detekt-cli/src/test/resources/autocorrect/SingleRuleCRLF.kt

@@ -0,0 +1,9 @@
+class Test {
+
+
+
+
+
+
+
+}

detekt-cli/src/test/resources/autocorrect/SingleRuleLF.kt

@@ -0,0 +1,9 @@
+class Test {
+
+
+
+
+
+
+
+}

detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/KtFileModifier.kt

@@ -1,7 +1,6 @@
 package io.gitlab.arturbosch.detekt.core
 
 import io.github.detekt.psi.absolutePath
-import io.github.detekt.psi.lineSeparator
 import io.gitlab.arturbosch.detekt.api.Detektion
 import io.gitlab.arturbosch.detekt.api.FileProcessListener
 import io.gitlab.arturbosch.detekt.api.Notification
@@ -27,7 +26,9 @@ class KtFileModifier : FileProcessListener {
     private fun KtFile.unnormalizeContent(): String =
         StringUtilRt.convertLineSeparators(
             checkNotNull(modifiedText),
-            lineSeparator
+            checkNotNull(virtualFile.detectedLineSeparator) {
+                "Line separator was not automatically detected. This is unexpected."
+            }
         )
 }
 

detekt-parser/src/main/kotlin/io/github/detekt/parser/KtCompiler.kt

@@ -1,7 +1,6 @@
 package io.github.detekt.parser
 
 import io.github.detekt.psi.absolutePath
-import io.github.detekt.psi.lineSeparator
 import org.intellij.lang.annotations.Language
 import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
 import org.jetbrains.kotlin.com.intellij.openapi.util.text.StringUtilRt
@@ -30,7 +29,7 @@ open class KtCompiler(
         return psiFile.apply {
             val normalizedAbsolutePath = path.absolute().normalize()
             this.absolutePath = normalizedAbsolutePath
-            this.lineSeparator = content.determineLineSeparator()
+            virtualFile.detectedLineSeparator = content.determineLineSeparator()
         }
     }
 }

detekt-parser/src/test/kotlin/io/github/detekt/parser/KtCompilerSpec.kt

@@ -1,6 +1,5 @@
 package io.github.detekt.parser
 
-import io.github.detekt.psi.lineSeparator
 import io.github.detekt.test.utils.resourceAsPath
 import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assertions.assertThatIllegalArgumentException
@@ -21,14 +20,20 @@ class KtCompilerSpec {
         fun `Kotlin file with LF line separators has extra user data`() {
             val ktFile = ktCompiler.compile(path.resolve("DefaultLf.kt"))
 
-            assertThat(ktFile.lineSeparator).isEqualTo("\n")
+            // visit file to trigger line detection
+            ktFile.accept(KtTreeVisitorVoid())
+
+            assertThat(ktFile.virtualFile.detectedLineSeparator).isEqualTo("\n")
         }
 
         @Test
         fun `Kotlin file with CRLF line separators has extra user data`() {
             val ktFile = ktCompiler.compile(path.resolve("DefaultCrLf.kt"))
 
-            assertThat(ktFile.lineSeparator).isEqualTo("\r\n")
+            // visit file to trigger line detection
+            ktFile.accept(KtTreeVisitorVoid())
+
+            assertThat(ktFile.virtualFile.detectedLineSeparator).isEqualTo("\r\n")
         }
 
         @Test

detekt-psi-utils/api/detekt-psi-utils.api

@@ -13,11 +13,6 @@ public final class io/github/detekt/psi/FunctionMatcher$Companion {
 	public final fun fromFunctionSignature (Ljava/lang/String;)Lio/github/detekt/psi/FunctionMatcher;
 }
 
-public final class io/github/detekt/psi/KeysKt {
-	public static final fun getLineSeparator (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;)Ljava/lang/String;
-	public static final fun setLineSeparator (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;Ljava/lang/String;)V
-}
-
 public final class io/github/detekt/psi/KtFilesKt {
 	public static final fun absolutePath (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;)Ljava/nio/file/Path;
 	public static final fun fileNameWithoutSuffix (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;Ljava/util/List;)Ljava/lang/String;