Fail OrganizeImports when RemoveUnused.imports is enabled (#2347)

Author: Copilot

scalafix-rules/src/main/scala/scalafix/internal/rule/OrganizeImports.scala

@@ -74,6 +74,7 @@ class OrganizeImports(
     config.conf
       .getOrElse("OrganizeImports")(OrganizeImportsConfig())
       .andThen(patchPreset(_, config.conf))
+      .andThen(checkRemoveUnusedConflict(_, config.conf))
       .andThen(checkScalacOptions(_, config.scalacOptions, config.scalaVersion))
 
   override def fix(implicit doc: SemanticDocument): Patch = {
@@ -864,6 +865,20 @@ object OrganizeImports {
     ConfDecoder[OrganizeImportsConfig].read(mergedConf)
   }
 
+  private def checkRemoveUnusedConflict(
+      ruleConf: OrganizeImportsConfig,
+      conf: Conf
+  ): Configured[OrganizeImportsConfig] =
+    conf.get[RemoveUnusedConfig]("RemoveUnused") match {
+      case Configured.Ok(config) if config.imports =>
+        Configured.error(
+          "\"RemoveUnused.imports\" and \"OrganizeImports\" should not be used together as they can produce broken code. " +
+            "Please disable \"RemoveUnused.imports\" by setting it to false, " +
+            "and use \"OrganizeImports.removeUnused\" instead to safely remove unused imports."
+        )
+      case _ => Configured.ok(ruleConf)
+    }
+
   private def checkScalacOptions(
       conf: OrganizeImportsConfig,
       scalacOptions: List[String],

scalafix-tests/unit/src/test/scala/scalafix/tests/config/OrganizeImportsConfigSuite.scala

@@ -0,0 +1,83 @@
+package scalafix.tests.config
+
+import metaconfig.Conf
+import metaconfig.Configured
+import metaconfig.typesafeconfig._
+import org.scalatest.funsuite.AnyFunSuite
+import scalafix.internal.rule.OrganizeImports
+import scalafix.v1.Configuration
+
+class OrganizeImportsConfigSuite extends AnyFunSuite {
+
+  test("OrganizeImports should fail when RemoveUnused.imports is enabled") {
+    val rawConfig =
+      """|rules = [OrganizeImports]
+        |OrganizeImports.removeUnused = true
+        |RemoveUnused.imports = true
+        |""".stripMargin
+
+    val conf = Conf.parseString("test", rawConfig).get
+    val config =
+      Configuration().withConf(conf).withScalacOptions(List("-Wunused"))
+    val rule = new OrganizeImports()
+
+    val result = rule.withConfiguration(config)
+
+    assert(
+      result.isNotOk,
+      "Expected OrganizeImports to fail with RemoveUnused.imports=true"
+    )
+
+    result match {
+      case Configured.NotOk(error) =>
+        val errorMsg = error.msg
+        assert(
+          errorMsg.contains("RemoveUnused.imports") &&
+            errorMsg.contains("OrganizeImports") &&
+            errorMsg.contains("should not be used together"),
+          s"Error message should mention the conflict. Got: $errorMsg"
+        )
+      case _ =>
+        fail("Expected Configured.NotOk")
+    }
+  }
+
+  test("OrganizeImports should succeed when RemoveUnused.imports is disabled") {
+    val rawConfig =
+      """|rules = [OrganizeImports]
+        |OrganizeImports.removeUnused = true
+        |RemoveUnused.imports = false
+        |""".stripMargin
+
+    val conf = Conf.parseString("test", rawConfig).get
+    val config =
+      Configuration().withConf(conf).withScalacOptions(List("-Wunused"))
+    val rule = new OrganizeImports()
+
+    val result = rule.withConfiguration(config)
+
+    assert(
+      result.isOk,
+      "Expected OrganizeImports to succeed with RemoveUnused.imports=false"
+    )
+  }
+
+  test("OrganizeImports should succeed when RemoveUnused is not configured") {
+    val rawConfig =
+      """|rules = [OrganizeImports]
+        |OrganizeImports.removeUnused = true
+        |""".stripMargin
+
+    val conf = Conf.parseString("test", rawConfig).get
+    val config =
+      Configuration().withConf(conf).withScalacOptions(List("-Wunused"))
+    val rule = new OrganizeImports()
+
+    val result = rule.withConfiguration(config)
+
+    assert(
+      result.isOk,
+      "Expected OrganizeImports to succeed when RemoveUnused is not configured"
+    )
+  }
+}