Merge pull request #3641 from Gedochao/feature/scalafix-test-scope

Apply `scalafix` rules to test scope inputs, too

Author: tgodzik

modules/cli/src/main/scala/scala/cli/commands/compile/Compile.scala

@@ -13,6 +13,7 @@ import scala.cli.commands.setupide.SetupIde
 import scala.cli.commands.shared.{HelpCommandGroup, HelpGroup, SharedOptions}
 import scala.cli.commands.update.Update
 import scala.cli.commands.util.BuildCommandHelpers
+import scala.cli.commands.util.BuildCommandHelpers.*
 import scala.cli.commands.{CommandUtils, ScalaCommand, SpecificationLevel, WatchUtil}
 import scala.cli.config.{ConfigDb, Keys}
 import scala.cli.packaging.Library.fullClassPathMaybeAsJar

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

@@ -54,6 +54,7 @@ object Fix extends ScalaCommand[FixOptions] {
             ScalafixRules.runRules(
               buildOptions = buildOpts,
               scalafixOptions = options.scalafix,
+              sharedOptions = options.shared,
               inputs = inputs,
               check = options.check,
               compilerMaker = compilerMaker,

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

@@ -11,16 +11,20 @@ import scala.build.errors.BuildException
 import scala.build.input.{Inputs, ScalaCliInvokeData}
 import scala.build.internal.{Constants, Runner}
 import scala.build.options.{BuildOptions, Scope}
-import scala.build.{Build, Logger, ScalafixArtifacts}
+import scala.build.{Build, Logger, Os, ScalafixArtifacts}
 import scala.cli.commands.fix.ScalafixOptions
+import scala.cli.commands.shared.SharedOptions
+import scala.cli.commands.util.BuildCommandHelpers.copyOutput
 import scala.cli.commands.util.CommandHelpers
+import scala.cli.commands.util.ScalacOptionsUtil.*
 import scala.jdk.CollectionConverters.*
 import scala.jdk.OptionConverters.*
 
 object ScalafixRules extends CommandHelpers {
   def runRules(
     buildOptions: BuildOptions,
     scalafixOptions: ScalafixOptions,
+    sharedOptions: SharedOptions,
     inputs: Inputs,
     compilerMaker: ScalaCompilerMaker,
     workspace: os.Path,
@@ -45,24 +49,28 @@ object ScalafixRules extends CommandHelpers {
       None,
       logger,
       crossBuilds = false,
-      buildTests = false,
+      buildTests = true,
       partial = None,
       actionableDiagnostics = actionableDiagnostics
     )
     val builds = res.orExit(logger)
 
-    builds.get(Scope.Main).flatMap(_.successfulOpt) match
-      case None => sys.exit(1)
-      case Some(build) =>
-        val classPaths    = build.fullClassPath
-        val scalacOptions = build.options.scalaOptions.scalacOptions.toSeq.map(_.value.value)
+    builds.builds match
+      case b if b.forall(_.success) =>
+        val successfulBuilds = b.collect { case s: Build.Successful => s }
+        successfulBuilds.foreach(_.copyOutput(sharedOptions))
+        val classPaths = successfulBuilds.flatMap(_.fullClassPath).distinct
+        val scalacOptions =
+          successfulBuilds.headOption.toSeq
+            .flatMap(_.options.scalaOptions.scalacOptions.toSeq.map(_.value.value))
 
         either {
           val artifacts =
             value(
               ScalafixArtifacts.artifacts(
                 scalaVersion,
-                build.options.classPathOptions.scalafixDependencies.values.flatten,
+                successfulBuilds.headOption.toSeq
+                  .flatMap(_.options.classPathOptions.scalafixDependencies.values.flatten),
                 value(buildOptions.finalRepositories),
                 logger,
                 buildOptions.internal.cache.getOrElse(FileCache())
@@ -76,10 +84,10 @@ object ScalafixRules extends CommandHelpers {
               Seq("--sourceroot", workspace.toString) ++
               Seq("--classpath", classPaths.mkString(java.io.File.pathSeparator)) ++
               Seq("--scala-version", scalaVersion) ++
-              (if (check) Seq("--test") else Nil) ++
-              (if (scalacOptions.nonEmpty) scalacOptions.flatMap(Seq("--scalac-options", _))
+              (if check then Seq("--test") else Nil) ++
+              (if scalacOptions.nonEmpty then scalacOptions.flatMap(Seq("--scalac-options", _))
                else Nil) ++
-              (if (artifacts.toolsJars.nonEmpty)
+              (if artifacts.toolsJars.nonEmpty then
                  Seq("--tool-classpath", artifacts.toolsJars.mkString(java.io.File.pathSeparator))
                else Nil) ++
               scalafixOptions.scalafixRules.flatMap(Seq("-r", _))

modules/cli/src/main/scala/scala/cli/commands/package0/Package.scala

@@ -37,6 +37,7 @@ import scala.cli.commands.publish.ConfigUtil.*
 import scala.cli.commands.run.Run.orPythonDetectionError
 import scala.cli.commands.shared.{HelpCommandGroup, HelpGroup, MainClassOptions, SharedOptions}
 import scala.cli.commands.util.BuildCommandHelpers
+import scala.cli.commands.util.BuildCommandHelpers.*
 import scala.cli.commands.{CommandUtils, ScalaCommand, WatchUtil}
 import scala.cli.config.{ConfigDb, Keys}
 import scala.cli.errors.ScalaJsLinkingError

modules/cli/src/main/scala/scala/cli/commands/run/Run.scala

@@ -25,6 +25,7 @@ import scala.cli.commands.run.RunMode
 import scala.cli.commands.setupide.SetupIde
 import scala.cli.commands.shared.{HelpCommandGroup, HelpGroup, SharedOptions}
 import scala.cli.commands.update.Update
+import scala.cli.commands.util.BuildCommandHelpers.*
 import scala.cli.commands.util.{BuildCommandHelpers, RunHadoop, RunSpark}
 import scala.cli.commands.{CommandUtils, ScalaCommand, SpecificationLevel, WatchUtil}
 import scala.cli.config.{ConfigDb, Keys}

modules/cli/src/main/scala/scala/cli/commands/util/BuildCommandHelpers.scala

@@ -6,7 +6,7 @@ import scala.cli.commands.ScalaCommand
 import scala.cli.commands.shared.SharedOptions
 import scala.cli.commands.util.ScalacOptionsUtil.*
 
-trait BuildCommandHelpers { self: ScalaCommand[_] =>
+trait BuildCommandHelpers { self: ScalaCommand[?] =>
   extension (successfulBuild: Build.Successful) {
     def retainedMainClass(
       logger: Logger,
@@ -17,6 +17,23 @@ trait BuildCommandHelpers { self: ScalaCommand[_] =>
         self.argvOpt.map(_.mkString(" ")).getOrElse(actualFullCommand),
         logger
       )
+  }
+
+  extension (builds: Builds) {
+    def anyBuildCancelled: Boolean = builds.all.exists {
+      case _: Build.Cancelled => true
+      case _                  => false
+    }
+
+    def anyBuildFailed: Boolean = builds.all.exists {
+      case _: Build.Failed => true
+      case _               => false
+    }
+  }
+}
+
+object BuildCommandHelpers {
+  extension (successfulBuild: Build.Successful) {
 
     /** -O -d defaults to --compile-output; if both are defined, --compile-output takes precedence
       */
@@ -34,16 +51,4 @@ trait BuildCommandHelpers { self: ScalaCommand[_] =>
           )
         }
   }
-
-  extension (builds: Builds) {
-    def anyBuildCancelled: Boolean = builds.all.exists {
-      case _: Build.Cancelled => true
-      case _                  => false
-    }
-
-    def anyBuildFailed: Boolean = builds.all.exists {
-      case _: Build.Failed => true
-      case _               => false
-    }
-  }
 }

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

@@ -292,4 +292,38 @@ trait FixScalafixRulesTestDefinitions {
       expect(updatedContent == expectedContent)
     }
   }
+
+  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)
+    }
+  }
 }