Skip to content

Commit 40cfc6c

Browse files
author
builduser
committed
Merged branch idea243.release into idea243.x
2 parents 5978533 + b92da0b commit 40cfc6c

File tree

6 files changed

+94
-22
lines changed

6 files changed

+94
-22
lines changed

‎scala/scala-impl/src/org/jetbrains/plugins/scala/lang/formatting/scalafmt/processors/ScalaFmtPreFormatProcessor.scala

+32-22
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import com.intellij.psi.javadoc.PsiDocComment
1818
import com.intellij.psi.util.PsiTreeUtil
1919
import org.apache.commons.lang3.StringUtils
2020
import org.jetbrains.annotations.{NonNls, TestOnly}
21+
import org.jetbrains.plugins.scala.ScalaBundle
2122
import org.jetbrains.plugins.scala.extensions.{PsiElementExt, _}
2223
import org.jetbrains.plugins.scala.lang.formatting.scalafmt.processors.PsiChange._
2324
import org.jetbrains.plugins.scala.lang.formatting.scalafmt.processors.ScalaFmtPreFormatProcessor._
@@ -38,8 +39,7 @@ import org.jetbrains.plugins.scala.lang.psi.impl.ScalaPsiElementFactory
3839
import org.jetbrains.plugins.scala.lang.psi.impl.expr.ScBlockImpl
3940
import org.jetbrains.plugins.scala.lang.psi.{ScalaPsiUtil, TypeAdjuster}
4041
import org.jetbrains.plugins.scala.lang.scaladoc.psi.api.ScDocComment
41-
import org.jetbrains.plugins.scala.project.UserDataHolderExt
42-
import org.jetbrains.plugins.scala.{ScalaBundle, ScalaFileType}
42+
import org.jetbrains.plugins.scala.project.{ScalaFeatures, UserDataHolderExt}
4343
import org.scalafmt.dynamic.exceptions.{PositionExceptionImpl, ReflectionException}
4444
import org.scalafmt.dynamic.{ScalafmtReflect, ScalafmtReflectConfig, ScalafmtVersion}
4545

@@ -48,6 +48,7 @@ import javax.swing.event.HyperlinkEvent
4848
import scala.annotation.{nowarn, tailrec}
4949
import scala.collection.immutable.ArraySeq
5050
import scala.collection.mutable
51+
import scala.jdk.CollectionConverters.CollectionHasAsScala
5152
import scala.util.Try
5253
import scala.util.control.NonFatal
5354
import scala.util.matching.Regex
@@ -421,7 +422,7 @@ object ScalaFmtPreFormatProcessor {
421422
}
422423
}
423424

424-
def processRange(elements: Seq[PsiElement], wrap: Boolean, typeAdjuster: TypeAdjuster): Either[Unit, Int] = {
425+
def processRange(elements: Seq[PsiElement], features: ScalaFeatures, wrap: Boolean, typeAdjuster: TypeAdjuster): Either[Unit, Int] = {
425426
val hasRewriteRules = context.config.hasRewriteRules
426427
val rewriteElements: Seq[PsiElement] = if (hasRewriteRules) elements.flatMap(maybeRewriteElements(_, range)) else Seq.empty
427428
val rewriteElementsToFormatted = attachFormattedCode(rewriteElements)
@@ -432,7 +433,7 @@ object ScalaFmtPreFormatProcessor {
432433
val formattedInSingleFile = formatInSingleFile(elements, wrap)(project, newContext)
433434
formattedInSingleFile match {
434435
case Some(formatted) =>
435-
replaceWithFormatted(elements, formatted, rewriteElementsToFormatted, range, typeAdjuster) match {
436+
replaceWithFormatted(elements, formatted, rewriteElementsToFormatted, features, range, typeAdjuster) match {
436437
case Left(err) =>
437438
reportMarkerNotFound(file, err)
438439
Left(())
@@ -454,11 +455,11 @@ object ScalaFmtPreFormatProcessor {
454455
Left(())
455456
} else {
456457
//failed to wrap some elements, try the whole file
457-
processRange(Seq(file), wrap = false, typeAdjuster).map(Some(_))
458+
processRange(Seq(file), file.features, wrap = false, typeAdjuster).map(Some(_))
458459
Right(None)
459460
}
460461
} else {
461-
processRange(elementsWrapped, wrap = true, typeAdjuster).map(Some(_))
462+
processRange(elementsWrapped, file.features, wrap = true, typeAdjuster).map(Some(_))
462463
}
463464
}
464465

@@ -477,23 +478,29 @@ object ScalaFmtPreFormatProcessor {
477478
private def getText(range: TextRange)(implicit fileText: String): String =
478479
fileText.substring(range.getStartOffset, range.getEndOffset)
479480

480-
private def unwrap(wrapFile: PsiFile)(implicit project: Project): Either[CantFindMarkerElementInFormattedCode, Seq[PsiElement]] = {
481+
private def unwrap(wrapFile: ScalaFile)(implicit project: Project): Either[CantFindMarkerElementInFormattedCode, Seq[PsiElement]] = {
481482
val text = wrapFile.getText
482483

483484
val startMarkerIdx = findMarker(text, StartMarkerFormattedRegex)
484485
// I don't know when it can be the case that start/end element are null, but handling it just to avoid exceptions
485-
val startElement = wrapFile.findElementAt(startMarkerIdx)
486-
if (startElement == null)
487-
return Left(CantFindMarkerElementInFormattedCode(true))
486+
if (startMarkerIdx == -1)
487+
return Left(CantFindMarkerElementInFormattedCode(isStartMarker = true))
488488

489489
val endMarkerIdx = findMarker(text, EndMarkerFormattedRegex)
490-
val endElement = wrapFile.findElementAt(endMarkerIdx)
491-
if (endElement == null)
492-
return Left(CantFindMarkerElementInFormattedCode(true))
490+
if (endMarkerIdx == -1)
491+
return Left(CantFindMarkerElementInFormattedCode(isStartMarker = false))
493492

494-
// we need to call extra `getParent` because findElementAt returns DOC_COMMENT_START
495-
val startMarker = startElement.getParent
496-
val endMarker = endElement.getParent
493+
val docComments = PsiTreeUtil.findChildrenOfType(wrapFile, classOf[ScDocComment]).asScala
494+
495+
val startMarker = docComments.find(e => e.getTextOffset == startMarkerIdx && StartMarkerFormattedRegex.matches(e.getText)) match {
496+
case None => return Left(CantFindMarkerElementInFormattedCode(isStartMarker = true))
497+
case Some(marker) => marker
498+
}
499+
500+
val endMarker = docComments.find(e => e.getTextOffset == endMarkerIdx && EndMarkerFormattedRegex.matches(e.getText)) match {
501+
case None => return Left(CantFindMarkerElementInFormattedCode(isStartMarker = false))
502+
case Some(marker) => marker
503+
}
497504

498505
assert(startMarker.is[ScDocComment])
499506
assert(endMarker.is[ScDocComment])
@@ -663,9 +670,10 @@ object ScalaFmtPreFormatProcessor {
663670
}
664671

665672
private def unwrapPsiFromFormattedFile(
666-
formattedCode: WrappedCode
673+
formattedCode: WrappedCode,
674+
features: ScalaFeatures
667675
)(implicit project: Project): Either[CantFindMarkerElementInFormattedCode, RewriteElements] = {
668-
val wrapFile = PsiFileFactory.getInstance(project).createFileFromText(DummyWrapperClassName, ScalaFileType.INSTANCE, formattedCode.text)
676+
val wrapFile = ScalaPsiElementFactory.createScalaFileFromText(formattedCode.text, features, shouldTrimText = false)
669677
val elementsUnwrapped: Either[CantFindMarkerElementInFormattedCode, Seq[PsiElement]] =
670678
if (formattedCode.wrapped) unwrap(wrapFile)
671679
else Right(Seq(wrapFile))
@@ -675,10 +683,11 @@ object ScalaFmtPreFormatProcessor {
675683
}
676684

677685
private def unwrapPsiFromFormattedElements(
678-
elementsToFormatted: Seq[(PsiElement, WrappedCode)]
686+
elementsToFormatted: Seq[(PsiElement, WrappedCode)],
687+
features: ScalaFeatures
679688
)(implicit project: Project): Seq[(PsiElement, Either[CantFindMarkerElementInFormattedCode, RewriteElements])] = {
680689
val withUnwrapped = elementsToFormatted.map { case (element, formattedCode) =>
681-
val unwrapped = unwrapPsiFromFormattedFile(formattedCode)
690+
val unwrapped = unwrapPsiFromFormattedFile(formattedCode, features)
682691
(element, unwrapped)
683692
}
684693
withUnwrapped.sortBy(_._1.getTextRange.getStartOffset)
@@ -687,18 +696,19 @@ object ScalaFmtPreFormatProcessor {
687696
private def replaceWithFormatted(elements: Iterable[PsiElement],
688697
formattedCode: WrappedCode,
689698
rewriteToFormatted: Seq[(PsiElement, WrappedCode)],
699+
features: ScalaFeatures,
690700
range: TextRange,
691701
typeAdjuster: TypeAdjuster)
692702
(implicit project: Project, fileText: String): Either[CantFindMarkerElementInFormattedCode, Int] = {
693-
val elementsUnwrapped: Seq[PsiElement] = unwrapPsiFromFormattedFile(formattedCode) match {
703+
val elementsUnwrapped: Seq[PsiElement] = unwrapPsiFromFormattedFile(formattedCode, features) match {
694704
case Right(value) =>
695705
value.elements
696706
case Left(err) =>
697707
return Left(err)
698708
}
699709
val elementsToTraverse: Iterable[(PsiElement, PsiElement)] = elements.zip(elementsUnwrapped)
700710
val rewriteElementsToTraverse0: Seq[(PsiElement, Either[CantFindMarkerElementInFormattedCode, RewriteElements])] =
701-
unwrapPsiFromFormattedElements(rewriteToFormatted)
711+
unwrapPsiFromFormattedElements(rewriteToFormatted, features)
702712

703713
rewriteElementsToTraverse0.find(_._2.isLeft) match {
704714
case Some((_, Left(err))) =>

‎scala/scala-impl/test/org/jetbrains/plugins/scala/lang/optimize/generated/OptimizeImportsWithScalafmtFormatter.scala

+19
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,22 @@ final class OptimizeImportsWithScalafmtFormatterWithLibraries extends OptimizeIm
7272
doTest()
7373
}
7474
}
75+
76+
class OptimizeImportsWithScalafmtFormatterRenamedImportsSource3 extends OptimizeImportsWithScalafmtFormatterBase {
77+
override protected def scalafmtVersion: String = "3.8.3"
78+
79+
def testSCL23689_NoChange(): Unit = runSCL23689Test()
80+
81+
def testSCL23689_Optimize(): Unit = runSCL23689Test()
82+
83+
private def runSCL23689Test(): Unit = RevertableChange.withCompilerSettingsModified(
84+
getModule,
85+
s => s.copy(additionalCompilerOptions = s.additionalCompilerOptions :+ "-Xsource:3")
86+
) {
87+
scalaCodeStyleSettings.SCALAFMT_USE_INTELLIJ_FORMATTER_FOR_RANGE_FORMAT = false
88+
doTest()
89+
90+
scalaCodeStyleSettings.SCALAFMT_USE_INTELLIJ_FORMATTER_FOR_RANGE_FORMAT = true
91+
doTest()
92+
}
93+
}

‎scala/scala-impl/testdata/optimize/scalafmt/SCL23689_NoChange.scala

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Notification message: null
2+
package example.bug
3+
4+
import java.lang as la
5+
import scala.concurrent.Future
6+
7+
class TestImports {
8+
def clientStateSurface(): Future[la.String] = ???
9+
}
10+
/*package example.bug
11+
12+
import java.lang as la
13+
import scala.concurrent.Future
14+
15+
class TestImports {
16+
def clientStateSurface(): Future[la.String] = ???
17+
}
18+
*/

‎scala/scala-impl/testdata/optimize/scalafmt/SCL23689_NoChange.scalafmt.conf

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version = "3.8.3"
2+
runner.dialect = scala3
3+
rewrite.trailingCommas.style = keep // `[`https://scalameta.org/scalafmt/docs/configuration.html#trailing-commas`](https://scalameta.org/scalafmt/docs/configuration.html#trailing-commas)

‎scala/scala-impl/testdata/optimize/scalafmt/SCL23689_Optimize.scala

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Notification message: Removed 2 imports, added 1 import
2+
package example.bug
3+
4+
import java.lang as la
5+
import scala.concurrent.Future
6+
import java.util.concurrent.CompletableFuture
7+
8+
class TestImports {
9+
def clientStateSurface(): Future[la.String] = ???
10+
}
11+
/*package example.bug
12+
13+
import java.lang as la
14+
import scala.concurrent.Future
15+
16+
class TestImports {
17+
def clientStateSurface(): Future[la.String] = ???
18+
}
19+
*/

‎scala/scala-impl/testdata/optimize/scalafmt/SCL23689_Optimize.scalafmt.conf

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version = "3.8.3"
2+
runner.dialect = scala3
3+
rewrite.trailingCommas.style = keep // `[`https://scalameta.org/scalafmt/docs/configuration.html#trailing-commas`](https://scalameta.org/scalafmt/docs/configuration.html#trailing-commas)

0 commit comments

Comments
 (0)