Scala 3: RemoveUnused cannot work as compiler support is missing

liancheng · May 15, 2021 · 795ff11 · 795ff11
1 parent ed1daa1
commit 795ff11
Show file tree

Hide file tree

Showing 46 changed files with 79 additions and 13 deletions.
diff --git a/input/src/main/scala/ExpandRelativeRootPackage.scala b/input/src/main/scala/ExpandRelativeRootPackage.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   expandRelative = true
   groupedImports = Explode

diff --git a/input/src/main/scala/OrganizeImportsRootPackage.scala b/input/src/main/scala/OrganizeImportsRootPackage.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groups = ["re:javax?\\.", "*", "scala."]
  */
 import java.time.Clock

diff --git a/input/src/main/scala/fix/AlreadyOrganized.scala b/input/src/main/scala/fix/AlreadyOrganized.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
  */
 package fix

diff --git a/input/src/main/scala/fix/BlankLinesManual.scala b/input/src/main/scala/fix/BlankLinesManual.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   blankLines = Manual
   groups = [

diff --git a/input/src/main/scala/fix/CoalesceImportees.scala b/input/src/main/scala/fix/CoalesceImportees.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   groupedImports = Keep
   coalesceToWildcardImportThreshold = 3

diff --git a/input/src/main/scala/fix/CurlyBracedSingleImportee.scala b/input/src/main/scala/fix/CurlyBracedSingleImportee.scala
@@ -1,4 +1,7 @@
-/* rules = [OrganizeImports] */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix
 
 import scala.collection.{Map}

diff --git a/input/src/main/scala/fix/DeduplicateImportees.scala b/input/src/main/scala/fix/DeduplicateImportees.scala
@@ -1,4 +1,7 @@
-/* rules = [OrganizeImports] */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix
 
 import scala.collection.immutable.Vector

diff --git a/input/src/main/scala/fix/ExpandRelative.scala b/input/src/main/scala/fix/ExpandRelative.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.expandRelative = true
  */
 package fix

diff --git a/input/src/main/scala/fix/ExpandRelativeMultiGroups.scala b/input/src/main/scala/fix/ExpandRelativeMultiGroups.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.expandRelative = true
  */
 package fix

diff --git a/input/src/main/scala/fix/ExpandRelativeQuotedIdent.scala b/input/src/main/scala/fix/ExpandRelativeQuotedIdent.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.expandRelative = true
  */
 package fix

diff --git a/input/src/main/scala/fix/ExpandRelativeRootPackage.scala b/input/src/main/scala/fix/ExpandRelativeRootPackage.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.expandRelative = true
  */
 package fix

diff --git a/input/src/main/scala/fix/GlobalImportsOnly.scala b/input/src/main/scala/fix/GlobalImportsOnly.scala
@@ -1,4 +1,7 @@
-/* rules = [OrganizeImports] */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix
 
 import scala.collection.mutable

diff --git a/input/src/main/scala/fix/GroupedImportsAggressiveMergeWildcard.scala b/input/src/main/scala/fix/GroupedImportsAggressiveMergeWildcard.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = AggressiveMerge
  */
 package fix

diff --git a/input/src/main/scala/fix/GroupedImportsExplode.scala b/input/src/main/scala/fix/GroupedImportsExplode.scala
@@ -1,4 +1,7 @@
-/* rules = [OrganizeImports] */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix
 
 import scala.collection.mutable.{ArrayBuffer, Buffer, StringBuilder}

diff --git a/input/src/main/scala/fix/GroupedImportsExplodeMixed.scala b/input/src/main/scala/fix/GroupedImportsExplodeMixed.scala
@@ -1,4 +1,7 @@
-/* rules = [OrganizeImports] */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix
 
 import scala.collection.immutable._

diff --git a/input/src/main/scala/fix/GroupedImportsExplodeUnimport.scala b/input/src/main/scala/fix/GroupedImportsExplodeUnimport.scala
@@ -1,4 +1,7 @@
-/* rules = [OrganizeImports] */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix
 
 import scala.collection.{Seq => _, _}

diff --git a/input/src/main/scala/fix/GroupedImportsKeep.scala b/input/src/main/scala/fix/GroupedImportsKeep.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Keep
  */
 package fix

diff --git a/input/src/main/scala/fix/GroupedImportsMerge.scala b/input/src/main/scala/fix/GroupedImportsMerge.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
  */
 package fix

diff --git a/input/src/main/scala/fix/GroupedImportsMergeDedup.scala b/input/src/main/scala/fix/GroupedImportsMergeDedup.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
  */
 package fix

diff --git a/input/src/main/scala/fix/GroupedImportsMergeRenames.scala b/input/src/main/scala/fix/GroupedImportsMergeRenames.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
  */
 package fix

diff --git a/input/src/main/scala/fix/GroupedImportsMergeUnimports.scala b/input/src/main/scala/fix/GroupedImportsMergeUnimports.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
  */
 package fix

diff --git a/input/src/main/scala/fix/GroupedImportsMergeWildcard.scala b/input/src/main/scala/fix/GroupedImportsMergeWildcard.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
  */
 package fix

diff --git a/input/src/main/scala/fix/Groups.scala b/input/src/main/scala/fix/Groups.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groups = ["re:javax?\\.", "*", "scala."]
  */
 package fix

diff --git a/input/src/main/scala/fix/GroupsLongestMatch.scala b/input/src/main/scala/fix/GroupsLongestMatch.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groups = ["re:javax?\\.", "scala.", "scala.util.", "*"]
  */
 package fix

diff --git a/input/src/main/scala/fix/ImportsOrderAsciiPreformatted.scala b/input/src/main/scala/fix/ImportsOrderAsciiPreformatted.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Keep
  */
 package fix

diff --git a/input/src/main/scala/fix/ImportsOrderKeep.scala b/input/src/main/scala/fix/ImportsOrderKeep.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   groupedImports = Keep
   importSelectorsOrder = Keep

diff --git a/input/src/main/scala/fix/ImportsOrderSymbolsFirst.scala b/input/src/main/scala/fix/ImportsOrderSymbolsFirst.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   groupedImports = Keep
   importSelectorsOrder = Keep

diff --git a/input/src/main/scala/fix/ImportsOrderSymbolsFirstPreformatted.scala b/input/src/main/scala/fix/ImportsOrderSymbolsFirstPreformatted.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   groupedImports = Keep
   importsOrder = SymbolsFirst

diff --git a/input/src/main/scala/fix/Inheritance.scala b/input/src/main/scala/fix/Inheritance.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.expandRelative = true
  */
 package fix

diff --git a/input/src/main/scala/fix/MergeImportsFormatPreserving.scala b/input/src/main/scala/fix/MergeImportsFormatPreserving.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Merge
  */
 

diff --git a/input/src/main/scala/fix/NoImports.scala b/input/src/main/scala/fix/NoImports.scala
@@ -1,4 +1,7 @@
-/* rules = OrganizeImports */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix
 
 object NoImports
diff --git a/input/src/main/scala/fix/PresetDefault.scala b/input/src/main/scala/fix/PresetDefault.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   preset = DEFAULT
   groupedImports = Merge

diff --git a/input/src/main/scala/fix/PresetIntelliJ_2020_3.scala b/input/src/main/scala/fix/PresetIntelliJ_2020_3.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   preset = INTELLIJ_2020_3
   groupedImports = Explode

diff --git a/input/src/main/scala/fix/RelativeImports.scala b/input/src/main/scala/fix/RelativeImports.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groups = ["scala.", "*"]
  */
 package fix

diff --git a/input/src/main/scala/fix/SortImportSelectorsAscii.scala b/input/src/main/scala/fix/SortImportSelectorsAscii.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groupedImports = Keep
  */
 package fix

diff --git a/input/src/main/scala/fix/SortImportSelectorsKeep.scala b/input/src/main/scala/fix/SortImportSelectorsKeep.scala
@@ -1,5 +1,6 @@
 /*
-rules = OrganizeImports
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   importSelectorsOrder = Keep
   groupedImports = Keep

diff --git a/input/src/main/scala/fix/SortImportSelectorsSymbolsFirst.scala b/input/src/main/scala/fix/SortImportSelectorsSymbolsFirst.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports {
   importSelectorsOrder = SymbolsFirst
   groupedImports = Keep

diff --git a/input/src/main/scala/fix/Suppression.scala b/input/src/main/scala/fix/Suppression.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groups = ["re:javax?\\.", "*", "scala."]
  */
 package fix

diff --git a/input/src/main/scala/fix/nested/NestedPackage.scala b/input/src/main/scala/fix/nested/NestedPackage.scala
@@ -1,5 +1,6 @@
 /*
 rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
 OrganizeImports.groups = ["re:javax?\\.", "*", "scala."]
  */
 package fix

diff --git a/input/src/main/scala/fix/nested/NestedPackageWithBraces.scala b/input/src/main/scala/fix/nested/NestedPackageWithBraces.scala
@@ -1,4 +1,7 @@
-/* rules = [OrganizeImports] */
+/*
+rules = [OrganizeImports]
+OrganizeImports.removeUnused = false
+ */
 package fix {
   package nested {
     import java.time.Clock

diff --git a/...rts/src/main/scala/fix/RemoveUnused.scala → ...s/src/main/scala-2/fix/RemoveUnused.scala b/...rts/src/main/scala/fix/RemoveUnused.scala → ...s/src/main/scala-2/fix/RemoveUnused.scala
diff --git a/...main/scala/fix/RemoveUnusedDisabled.scala → ...in/scala-2/fix/RemoveUnusedDisabled.scala b/...main/scala/fix/RemoveUnusedDisabled.scala → ...in/scala-2/fix/RemoveUnusedDisabled.scala
diff --git a/...rc/main/scala/fix/RemoveUnusedLocal.scala → .../main/scala-2/fix/RemoveUnusedLocal.scala b/...rc/main/scala/fix/RemoveUnusedLocal.scala → .../main/scala-2/fix/RemoveUnusedLocal.scala
diff --git a/...rc/main/scala/fix/RemoveUnusedMixed.scala → .../main/scala-2/fix/RemoveUnusedMixed.scala b/...rc/main/scala/fix/RemoveUnusedMixed.scala → .../main/scala-2/fix/RemoveUnusedMixed.scala
diff --git a/...main/scala/fix/RemoveUnusedRelative.scala → ...in/scala-2/fix/RemoveUnusedRelative.scala b/...main/scala/fix/RemoveUnusedRelative.scala → ...in/scala-2/fix/RemoveUnusedRelative.scala
diff --git a/rules/src/main/scala/fix/OrganizeImports.scala b/rules/src/main/scala/fix/OrganizeImports.scala
@@ -60,7 +60,7 @@ class OrganizeImports(config: OrganizeImportsConfig) extends SemanticRule("Organ
     config.conf
       .getOrElse("OrganizeImports")(OrganizeImportsConfig())
       .andThen(patchPreset(_, config.conf))
-      .andThen(checkScalacOptions(_, config.scalacOptions))
+      .andThen(checkScalacOptions(_, config.scalacOptions, config.scalaVersion))
 
   override def fix(implicit doc: SemanticDocument): Patch = {
     unusedImporteePositions ++= doc.diagnostics.collect {
@@ -614,9 +614,12 @@ object OrganizeImports {
 
   private def checkScalacOptions(
     conf: OrganizeImportsConfig,
-    scalacOptions: List[String]
+    scalacOptions: List[String],
+    scalaVersion: String
   ): Configured[Rule] = {
-    val hasWarnUnused = {
+    val hasCompilerSupport = scalaVersion.startsWith("2")
+
+    val hasWarnUnused = hasCompilerSupport && {
       val warnUnusedPrefix = Set("-Wunused", "-Ywarn-unused")
       val warnUnusedString = Set("-Xlint", "-Xlint:unused")
       scalacOptions exists { option =>
@@ -626,13 +629,20 @@ object OrganizeImports {
 
     if (!conf.removeUnused || hasWarnUnused)
       Configured.ok(new OrganizeImports(conf))
-    else
+    else if (hasCompilerSupport)
       Configured.error(
         "The Scala compiler option \"-Ywarn-unused\" is required to use OrganizeImports with"
           + " \"OrganizeImports.removeUnused\" set to true. To fix this problem, update your"
           + " build to use at least one Scala compiler option like -Ywarn-unused-import (2.11"
           + " only), -Ywarn-unused, -Xlint:unused (2.12.2 or above) or -Wunused (2.13 only)."
       )
+    else
+      Configured.error(
+        "\"OrganizeImports.removeUnused\" is not supported on Scala 3 as the compiler is"
+          + " not providing enough information. Run the rule with"
+          + " \"OrganizeImports.removeUnused\" set to false to organize imports while keeping"
+          + " potentially unused imports."
+      )
   }
 
   private def buildImportMatchers(config: OrganizeImportsConfig): Seq[ImportMatcher] = {