OrganizeImports: support Scala3 syntax as output

scalacenter · Jan 20, 2024 · 68dc414 · 68dc414
1 parent 77eca36
commit 68dc414
Show file tree

Hide file tree

Showing 60 changed files with 209 additions and 27 deletions.
diff --git a/scalafix-rules/src/main/scala/scalafix/internal/rule/OrganizeImports.scala b/scalafix-rules/src/main/scala/scalafix/internal/rule/OrganizeImports.scala
@@ -572,7 +572,12 @@ class OrganizeImports(
 
       importer match {
         case Importer(_, Importee.Wildcard() :: Nil) =>
-          syntax.patch(syntax.lastIndexOfSlice("._"), ".\u0001", 2)
+          val wildcardSyntax = Importee.Wildcard().syntax
+          syntax.patch(
+            syntax.lastIndexOfSlice(s".$wildcardSyntax"),
+            ".\u0001",
+            2
+          )
 
         case _ if importer.isCurlyBraced =>
           syntax
@@ -714,9 +719,48 @@ class OrganizeImports(
   private def importerSyntax(importer: Importer): String =
     importer.pos match {
       case pos: Position.Range =>
-        // Position found, implies that `importer` was directly parsed from the source code. Returns
-        // the original parsed text to preserve the original source level formatting.
-        pos.text
+        // Position found, implies that `importer` was directly parsed from the source code. Use
+        // the original parsed text to preserve the original source level formatting, but patch
+        // importee that have specific Scala 3 syntax.
+        val syntax = new StringBuilder(pos.text)
+        def patchSyntax(
+            t: Tree,
+            newSyntax: String,
+            stripEnclosingBraces: Boolean = false
+        ) = {
+          val start = t.pos.start - pos.start
+          syntax.replace(start, t.pos.end - pos.start, newSyntax)
+          val end = t.pos.start - pos.start + newSyntax.length
+
+          if (stripEnclosingBraces)
+            (
+              syntax.take(start).lastIndexOf('{'),
+              syntax.indexOf('}', end)
+            ) match {
+              case (from, to) if from != -1 && to != -1 =>
+                syntax.delete(end, to + 1)
+                syntax.delete(from, start)
+              case _ =>
+            }
+        }
+        val Importer(_, importees) = importer
+        val optionalBraces =
+          importees.length == 1 && targetDialect.allowAsForImportRename
+        // traverse & patch backwards to avoid shifting indices
+        importees.reverse.foreach {
+          case i @ Importee.Rename(_, _) =>
+            patchSyntax(i, i.copy().syntax, optionalBraces)
+          case i @ Importee.Unimport(_) =>
+            patchSyntax(i, i.copy().syntax, optionalBraces)
+          case i @ Importee.Wildcard() =>
+            patchSyntax(i, i.copy().syntax)
+          case i @ Importee.GivenAll() =>
+            patchSyntax(i, i.copy().syntax, importees.length == 1)
+          case i @ Importee.Given(_) =>
+            patchSyntax(i, i.copy().syntax, importees.length == 1)
+          case _ =>
+        }
+        syntax.toString
 
       case Position.None =>
         // Position not found, implies that `importer` is derived from certain existing import
@@ -742,7 +786,9 @@ class OrganizeImports(
     def isCurlyBraced: Boolean = {
       val importees @ Importees(_, renames, unimports, _, _, _) =
         importer.importees
-      renames.nonEmpty || unimports.nonEmpty || importees.length > 1
+
+      importees.length > 1 ||
+      ((renames.length == 1 || unimports.length == 1) && !targetDialect.allowAsForImportRename)
     }
 
     /**

diff --git a/...x-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesGivensAndNames.scala b/...x-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesGivensAndNames.scala
@@ -4,6 +4,7 @@ OrganizeImports {
   groupedImports = Keep
   coalesceToWildcardImportThreshold = 2
   removeUnused = false
+  targetDialect = Scala3
 }
  */
 package test.organizeImports

diff --git a/scalafix-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivens.scala b/scalafix-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivens.scala
@@ -4,6 +4,7 @@ OrganizeImports {
   groupedImports = Keep
   coalesceToWildcardImportThreshold = 2
   removeUnused = false
+  targetDialect = Scala3
 }
  */
 package test.organizeImports

diff --git a/...-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivensNoNames.scala b/...-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivensNoNames.scala
@@ -4,6 +4,7 @@ OrganizeImports {
   groupedImports = Keep
   coalesceToWildcardImportThreshold = 2
   removeUnused = false
+  targetDialect = Scala3
 }
  */
 package test.organizeImports

diff --git a/scalafix-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesNoNames.scala b/scalafix-tests/input/src/main/scala-3/test/organizeImports/CoalesceImporteesNoNames.scala
@@ -4,6 +4,7 @@ OrganizeImports {
   groupedImports = Keep
   coalesceToWildcardImportThreshold = 2
   removeUnused = false
+  targetDialect = Scala3
 }
  */
 package test.organizeImports

diff --git a/scalafix-tests/input/src/main/scala-3/test/organizeImports/DeduplicateGivenImportees.scala b/scalafix-tests/input/src/main/scala-3/test/organizeImports/DeduplicateGivenImportees.scala
@@ -1,6 +1,7 @@
 /*
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
+OrganizeImports.targetDialect = Scala3
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala-3/test/organizeImports/ExpandGiven.scala b/scalafix-tests/input/src/main/scala-3/test/organizeImports/ExpandGiven.scala
@@ -1,12 +1,15 @@
 /*
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
+OrganizeImports.targetDialect = Scala3
  */
 package test.organizeImports
 
 import test.organizeImports.GivenImports.Beta
 import test.organizeImports.GivenImports.Alpha
 import test.organizeImports.GivenImports.{given Beta, given Alpha}
+import test.organizeImports.GivenImports2.{given Beta}
+import test.organizeImports.GivenImports2.{given}
 import scala.util.Either
 
 object ExpandGiven
diff --git a/scalafix-tests/input/src/main/scala-3/test/organizeImports/ExpandUnimportGiven.scala b/scalafix-tests/input/src/main/scala-3/test/organizeImports/ExpandUnimportGiven.scala
@@ -1,6 +1,7 @@
 /*
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
+OrganizeImports.targetDialect = Scala3
  */
 package test.organizeImports
 

diff --git a/...tests/input/src/main/scala-3/test/organizeImports/GroupedGivenImportsMergeUnimports.scala b/...tests/input/src/main/scala-3/test/organizeImports/GroupedGivenImportsMergeUnimports.scala
@@ -2,17 +2,18 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
+OrganizeImports.targetDialect = Scala3
  */
 package test.organizeImports
 
-import test.organizeImports.GivenImports._
-import test.organizeImports.GivenImports.{alpha => _, given}
+import test.organizeImports.GivenImports.*
+import test.organizeImports.GivenImports.{alpha as _, given}
 import test.organizeImports.GivenImports.{given Beta}
-import test.organizeImports.GivenImports.{gamma => _, given}
+import test.organizeImports.GivenImports.{gamma as _, given}
 import test.organizeImports.GivenImports.{given Zeta}
 
-import test.organizeImports.GivenImports2.{alpha => _}
-import test.organizeImports.GivenImports2.{beta => _}
+import test.organizeImports.GivenImports2.{alpha as _}
+import test.organizeImports.GivenImports2.beta as _
 import test.organizeImports.GivenImports2.{given Gamma}
 import test.organizeImports.GivenImports2.{given Zeta}
 

diff --git a/...s/input/src/main/scala-3/test/organizeImports/GroupedImportsAggressiveMergeGivenAll.scala b/...s/input/src/main/scala-3/test/organizeImports/GroupedImportsAggressiveMergeGivenAll.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = AggressiveMerge
+OrganizeImports.targetDialect = Scala3
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala-3/test/organizeImports/MergeGiven.scala b/scalafix-tests/input/src/main/scala-3/test/organizeImports/MergeGiven.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
+OrganizeImports.targetDialect = Scala3
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/CoalesceImportees.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/CoalesceImportees.scala
@@ -4,6 +4,7 @@ OrganizeImports {
   groupedImports = Keep
   coalesceToWildcardImportThreshold = 3
   removeUnused = false
+  targetDialect = Auto
 }
  */
 package test.organizeImports

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/CurlyBracedSingleImportee.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/CurlyBracedSingleImportee.scala
@@ -1,10 +1,12 @@
 /*
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 
 import scala.collection.{Map}
+import scala.collection.{Seq => _}
 import scala.collection.{Set => ImmutableSet}
 
 object CurlyBracedSingleImportee
diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/ExpandRelativeRootPackage.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/ExpandRelativeRootPackage.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.expandRelative = true
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/...afix-tests/input/src/main/scala/test/organizeImports/ExplodeImportsFormatPreserving.scala b/...afix-tests/input/src/main/scala/test/organizeImports/ExplodeImportsFormatPreserving.scala
@@ -2,11 +2,12 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Explode
+OrganizeImports.targetDialect = Auto
  */
 
 package test.organizeImports
 
 import test.organizeImports.ExplodeImports.FormatPreserving.g1.{ a, b }
-import test.organizeImports.ExplodeImports.FormatPreserving.g2.{ c => C, _ }
+import test.organizeImports.ExplodeImports.FormatPreserving.g2.{ c  =>  C, _ }
 
 object ExplodeImportsFormatPreserving
diff --git a/...sts/input/src/main/scala/test/organizeImports/GroupedImportsAggressiveMergeWildcard.scala b/...sts/input/src/main/scala/test/organizeImports/GroupedImportsAggressiveMergeWildcard.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = AggressiveMerge
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsExplodeMixed.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsExplodeMixed.scala
@@ -1,6 +1,7 @@
 /*
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsExplodeUnimport.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsExplodeUnimport.scala
@@ -1,6 +1,7 @@
 /*
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeDedup.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeDedup.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeRenames.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeRenames.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeUnimports.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeUnimports.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeWildcard.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/GroupedImportsMergeWildcard.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
+OrganizeImports.targetDialect = Auto
  */
 package test.organizeImports
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/ImportsOrderKeep.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/ImportsOrderKeep.scala
@@ -5,6 +5,7 @@ OrganizeImports {
   groupedImports = Keep
   importSelectorsOrder = Keep
   importsOrder = Keep
+  targetDialect = Auto
 }
  */
 package test.organizeImports

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/ImportsOrderSymbolsFirst.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/ImportsOrderSymbolsFirst.scala
@@ -5,6 +5,7 @@ OrganizeImports {
   groupedImports = Keep
   importSelectorsOrder = Keep
   importsOrder = SymbolsFirst
+  targetDialect = Auto
 }
  */
 package test.organizeImports
@@ -15,6 +16,9 @@ import scala.concurrent.duration
 import scala.concurrent.{Promise, Future}
 
 import test.organizeImports.QuotedIdent.`a.b`.`{ d }`.e
+import test.organizeImports.QuotedIdent.`a.b`.`{ d }`.{  e => E  }
+import test.organizeImports.QuotedIdent.`a.b`
+import test.organizeImports.QuotedIdent.{`a.b` => ab}
 import test.organizeImports.QuotedIdent.`a.b`.{c => _, _}
 import test.organizeImports.QuotedIdent._
 

diff --git a/scalafix-tests/input/src/main/scala/test/organizeImports/MergeImportsFormatPreserving.scala b/scalafix-tests/input/src/main/scala/test/organizeImports/MergeImportsFormatPreserving.scala
@@ -2,6 +2,7 @@
 rules = [OrganizeImports]
 OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
+OrganizeImports.targetDialect = Auto
  */
 
 package test.organizeImports

diff --git a/...t/organizeImports/CoalesceImportees.scala → ...t/organizeImports/CoalesceImportees.scala b/...t/organizeImports/CoalesceImportees.scala → ...t/organizeImports/CoalesceImportees.scala
diff --git a/...zeImports/CurlyBracedSingleImportee.scala → ...zeImports/CurlyBracedSingleImportee.scala b/...zeImports/CurlyBracedSingleImportee.scala → ...zeImports/CurlyBracedSingleImportee.scala
@@ -1,6 +1,7 @@
 package test.organizeImports
 
 import scala.collection.Map
+import scala.collection.{Seq => _}
 import scala.collection.{Set => ImmutableSet}
 
 object CurlyBracedSingleImportee
diff --git a/...orts/ExplodeImportsFormatPreserving.scala → ...orts/ExplodeImportsFormatPreserving.scala b/...orts/ExplodeImportsFormatPreserving.scala → ...orts/ExplodeImportsFormatPreserving.scala
diff --git a/...oupedImportsAggressiveMergeWildcard.scala → ...oupedImportsAggressiveMergeWildcard.scala b/...oupedImportsAggressiveMergeWildcard.scala → ...oupedImportsAggressiveMergeWildcard.scala
diff --git a/...eImports/GroupedImportsExplodeMixed.scala → ...eImports/GroupedImportsExplodeMixed.scala b/...eImports/GroupedImportsExplodeMixed.scala → ...eImports/GroupedImportsExplodeMixed.scala
diff --git a/...ports/GroupedImportsExplodeUnimport.scala → ...ports/GroupedImportsExplodeUnimport.scala b/...ports/GroupedImportsExplodeUnimport.scala → ...ports/GroupedImportsExplodeUnimport.scala
diff --git a/...izeImports/GroupedImportsMergeDedup.scala → ...izeImports/GroupedImportsMergeDedup.scala b/...izeImports/GroupedImportsMergeDedup.scala → ...izeImports/GroupedImportsMergeDedup.scala
diff --git a/...eImports/GroupedImportsMergeRenames.scala → ...eImports/GroupedImportsMergeRenames.scala b/...eImports/GroupedImportsMergeRenames.scala → ...eImports/GroupedImportsMergeRenames.scala
diff --git a/...mports/GroupedImportsMergeUnimports.scala → ...mports/GroupedImportsMergeUnimports.scala b/...mports/GroupedImportsMergeUnimports.scala → ...mports/GroupedImportsMergeUnimports.scala
diff --git a/...Imports/GroupedImportsMergeWildcard.scala → ...Imports/GroupedImportsMergeWildcard.scala b/...Imports/GroupedImportsMergeWildcard.scala → ...Imports/GroupedImportsMergeWildcard.scala
diff --git a/...st/organizeImports/ImportsOrderKeep.scala → ...st/organizeImports/ImportsOrderKeep.scala b/...st/organizeImports/ImportsOrderKeep.scala → ...st/organizeImports/ImportsOrderKeep.scala
diff --git a/...izeImports/ImportsOrderSymbolsFirst.scala → ...izeImports/ImportsOrderSymbolsFirst.scala b/...izeImports/ImportsOrderSymbolsFirst.scala → ...izeImports/ImportsOrderSymbolsFirst.scala
@@ -1,7 +1,10 @@
 package test.organizeImports
 
 import test.organizeImports.QuotedIdent._
+import test.organizeImports.QuotedIdent.{`a.b` => ab}
+import test.organizeImports.QuotedIdent.`a.b`
 import test.organizeImports.QuotedIdent.`a.b`.{c => _, _}
+import test.organizeImports.QuotedIdent.`a.b`.`{ d }`.{  e => E  }
 import test.organizeImports.QuotedIdent.`a.b`.`{ d }`.e
 
 import scala.concurrent._

diff --git a/...mports/MergeImportsFormatPreserving.scala → ...mports/MergeImportsFormatPreserving.scala b/...mports/MergeImportsFormatPreserving.scala → ...mports/MergeImportsFormatPreserving.scala
diff --git a/scalafix-tests/output/src/main/scala-3/test/organizeImports/CoalesceImportees.scala b/scalafix-tests/output/src/main/scala-3/test/organizeImports/CoalesceImportees.scala
@@ -0,0 +1,8 @@
+package test.organizeImports
+
+import scala.collection.immutable.{Map, Seq, Vector}
+import scala.collection.mutable.*
+import scala.concurrent.{Channel as Ch, *}
+import scala.util.{Random as _, *}
+
+object CoalesceImportees
diff --git a/...-tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesGivensAndNames.scala b/...-tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesGivensAndNames.scala
@@ -1,6 +1,6 @@
 package test.organizeImports
 
-import test.organizeImports.Givens._
-import test.organizeImports.Givens.{B => B1, C => _, _, given}
+import test.organizeImports.Givens.*
+import test.organizeImports.Givens.{B as B1, C as _, *, given}
 
 object CoalesceImporteesGivensAndNames
diff --git a/scalafix-tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivens.scala b/scalafix-tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivens.scala
@@ -1,5 +1,5 @@
 package test.organizeImports
 
-import test.organizeImports.Givens.{C => C1, _}
+import test.organizeImports.Givens.{C as C1, *}
 
 object CoalesceImporteesNoGivens
diff --git a/...tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivensNoNames.scala b/...tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesNoGivensNoNames.scala
@@ -1,5 +1,5 @@
 package test.organizeImports
 
-import test.organizeImports.Givens.{A => A1, B => _, _}
+import test.organizeImports.Givens.{A as A1, B as _, *}
 
 object CoalesceImporteesNoGivensNoNames
diff --git a/scalafix-tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesNoNames.scala b/scalafix-tests/output/src/main/scala-3/test/organizeImports/CoalesceImporteesNoNames.scala
@@ -1,6 +1,6 @@
 package test.organizeImports
 
-import test.organizeImports.Givens._
-import test.organizeImports.Givens.{A => A1, given}
+import test.organizeImports.Givens.*
+import test.organizeImports.Givens.{A as A1, given}
 
 object CoalesceImporteesNoNames
diff --git a/scalafix-tests/output/src/main/scala-3/test/organizeImports/CurlyBracedSingleImportee.scala b/scalafix-tests/output/src/main/scala-3/test/organizeImports/CurlyBracedSingleImportee.scala
@@ -0,0 +1,7 @@
+package test.organizeImports
+
+import scala.collection.Map
+import scala.collection.Seq as _
+import scala.collection.Set as ImmutableSet
+
+object CurlyBracedSingleImportee
diff --git a/scalafix-tests/output/src/main/scala-3/test/organizeImports/DeduplicateGivenImportees.scala b/scalafix-tests/output/src/main/scala-3/test/organizeImports/DeduplicateGivenImportees.scala
@@ -1,6 +1,6 @@
 package test.organizeImports
 
-import test.organizeImports.Givens._
+import test.organizeImports.Givens.*
 import test.organizeImports.Givens.given A
 import test.organizeImports.Givens.given B
 import test.organizeImports.Givens.given C

diff --git a/scalafix-tests/output/src/main/scala-3/test/organizeImports/ExpandGiven.scala b/scalafix-tests/output/src/main/scala-3/test/organizeImports/ExpandGiven.scala
@@ -4,6 +4,8 @@ import test.organizeImports.GivenImports.Alpha
 import test.organizeImports.GivenImports.Beta
 import test.organizeImports.GivenImports.given Alpha
 import test.organizeImports.GivenImports.given Beta
+import test.organizeImports.GivenImports2.given
+import test.organizeImports.GivenImports2.given Beta
 
 import scala.util.Either