Ensure fix sub-command respects the --semanticdb flag

Author: Gedochao

modules/cli/src/main/scala/scala/cli/commands/fix/ScalafixRules.scala

@@ -10,6 +10,7 @@ import scala.build.compiler.ScalaCompilerMaker
 import scala.build.errors.BuildException
 import scala.build.input.{Inputs, ScalaCliInvokeData}
 import scala.build.internal.{Constants, Runner}
+import scala.build.internals.ConsoleUtils.ScalaCliConsole.warnPrefix
 import scala.build.options.{BuildOptions, Scope}
 import scala.build.{Build, Logger, Os, ScalafixArtifacts}
 import scala.cli.commands.fix.ScalafixOptions
@@ -32,11 +33,28 @@ object ScalafixRules extends CommandHelpers {
     actionableDiagnostics: Option[Boolean],
     logger: Logger
   )(using ScalaCliInvokeData): Either[BuildException, Int] = {
-    val buildOptionsWithSemanticDb = buildOptions.copy(scalaOptions =
-      buildOptions.scalaOptions.copy(semanticDbOptions =
-        buildOptions.scalaOptions.semanticDbOptions.copy(generateSemanticDbs = Some(true))
-      )
-    )
+    sharedOptions.semanticDbOptions.semanticDb match {
+      case Some(false) =>
+        logger.message(
+          s"""$warnPrefix SemanticDB files' generation was explicitly set to false.
+             |$warnPrefix Some scalafix rules require .semanticdb files and may not work properly."""
+            .stripMargin
+        )
+      case Some(true) =>
+        logger.debug("SemanticDB files' generation enabled.")
+      case None =>
+        logger.debug("Defaulting SemanticDB files' generation to true, to satisfy scalafix needs.")
+    }
+    val buildOptionsWithSemanticDb =
+      if buildOptions.scalaOptions.semanticDbOptions.generateSemanticDbs.isEmpty then
+        buildOptions.copy(scalaOptions =
+          buildOptions.scalaOptions.copy(semanticDbOptions =
+            buildOptions.scalaOptions.semanticDbOptions.copy(generateSemanticDbs =
+              Some(true)
+            )
+          )
+        )
+      else buildOptions
 
     val scalaVersion =
       buildOptions.scalaParams.orExit(logger).map(_.scalaVersion)

modules/integration/src/test/scala/scala/cli/integration/FixScalafixRulesTestDefinitions.scala

@@ -2,6 +2,8 @@ package scala.cli.integration
 
 import com.eed3si9n.expecty.Expecty.expect
 
+import scala.util.Properties
+
 trait FixScalafixRulesTestDefinitions {
   _: FixTestDefinitions =>
   protected val scalafixConfFileName: String = ".scalafix.conf"
@@ -293,37 +295,58 @@ trait FixScalafixRulesTestDefinitions {
     }
   }
 
-  test("scalafix rules requiring SemanticDB run correctly with test scope sources") {
-    val compilerOptions =
-      if (actualScalaVersion.startsWith("2.12")) Seq("-Ywarn-unused-import")
-      else Seq("-Wunused:imports")
-    TestInputs(
-      os.rel / scalafixConfFileName ->
-        """rules = [
-          |  DisableSyntax,
-          |  LeakingImplicitClassVal,
-          |  NoValInForComprehension,
-          |  ExplicitResultTypes,
-          |  OrganizeImports
-          |]
-          |ExplicitResultTypes.fetchScala3CompilerArtifactsOnVersionMismatch = true
-          |""".stripMargin,
-      os.rel / projectFileName ->
-        s"""//> using test.dep org.scalameta::munit::${Constants.munitVersion}
-           |//> using options ${compilerOptions.mkString(" ")}
-           |""".stripMargin,
-      os.rel / "example.test.scala" ->
-        """import munit.FunSuite
-          |
-          |class Munit extends FunSuite {
-          |  test("foo") {
-          |    assert(2 + 2 == 4)
-          |    println("Hello from Munit")
-          |  }
-          |}
-          |""".stripMargin
-    ).fromRoot { root =>
-      os.proc(TestUtil.cli, "fix", ".", "--power", extraOptions).call(cwd = root)
-    }
+  for {
+    (semanticDbOptions, expectedSuccess) <- Seq(
+      Nil -> true, // .semanticdb files should be implicitly generated when Scalafix is run
+      Seq("--semanticdb")       -> true,
+      Seq("--semanticdb=false") -> false
+    )
+    semanticDbOptionsDescription =
+      if (semanticDbOptions.nonEmpty) s" (${semanticDbOptions.mkString(" ")})"
+      else ""
+    verb = if (expectedSuccess) "run" else "fail"
+    if !Properties.isWin || expectedSuccess
   }
+    test(
+      s"scalafix rules requiring SemanticDB $verb correctly with test scope sources$semanticDbOptionsDescription"
+    ) {
+      val compilerOptions =
+        if (actualScalaVersion.startsWith("2.12")) Seq("-Ywarn-unused-import")
+        else Seq("-Wunused:imports")
+      TestInputs(
+        os.rel / scalafixConfFileName ->
+          """rules = [
+            |  DisableSyntax,
+            |  LeakingImplicitClassVal,
+            |  NoValInForComprehension,
+            |  ExplicitResultTypes,
+            |  OrganizeImports
+            |]
+            |ExplicitResultTypes.fetchScala3CompilerArtifactsOnVersionMismatch = true
+            |""".stripMargin,
+        os.rel / projectFileName ->
+          s"""//> using test.dep org.scalameta::munit::${Constants.munitVersion}
+             |//> using options ${compilerOptions.mkString(" ")}
+             |""".stripMargin,
+        os.rel / "example.test.scala" ->
+          """import munit.FunSuite
+            |
+            |class Munit extends FunSuite {
+            |  test("foo") {
+            |    assert(2 + 2 == 4)
+            |    println("Hello from Munit")
+            |  }
+            |}
+            |""".stripMargin
+      ).fromRoot { root =>
+        val res = os.proc(TestUtil.cli, "fix", ".", "--power", semanticDbOptions, extraOptions)
+          .call(cwd = root, check = false, stderr = os.Pipe)
+        val successful = res.exitCode == 0
+        expect(successful == expectedSuccess)
+        if (!expectedSuccess)
+          expect(
+            res.err.trim().contains("SemanticDB files' generation was explicitly set to false")
+          )
+      }
+    }
 }