Move compile --output to SharedOptions and rename it to --compile-output; prevent the -d underlying compiler flag from being set repeatedly and default it to --compile-output

Author: Gedochao

modules/cli-options/src/main/scala/scala/cli/commands/CompileOptions.scala

@@ -18,13 +18,6 @@ final case class CompileOptions(
   @HelpMessage("Print the resulting class path")
     printClassPath: Boolean = false,
 
-  @Name("output-directory")
-  @Name("d")
-  @Name("destination")
-  @HelpMessage("Copy compilation results to output directory using either relative or absolute path")
-  @ValueDescription("/example/path")
-    output: Option[String] = None,
-
   @HelpMessage("Compile test scope")
     test: Boolean = false
 )

modules/cli-options/src/main/scala/scala/cli/commands/SharedOptions.scala

@@ -117,6 +117,15 @@ final case class SharedOptions(
 
   @Hidden
     strictBloopJsonCheck: Option[Boolean] = None,
+
+  @Name("output-directory")
+  @Name("d")
+  @Name("destination")
+  @Name("compileOutput")
+  @Name("compileOut")
+  @HelpMessage("Copy compilation results to output directory using either relative or absolute path")
+  @ValueDescription("/example/path")
+    compilationOutput: Option[String] = None,
 )
   // format: on
 

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

@@ -3,21 +3,18 @@ package scala.cli.commands
 import caseapp._
 
 import java.io.File
-
 import scala.build.options.Scope
 import scala.build.{Build, BuildThreads, Builds, Os}
 import scala.cli.CurrentParams
+import scala.cli.commands.util.BuildCommandHelpers
 import scala.cli.commands.util.SharedOptionsUtil._
 import scala.cli.config.{ConfigDb, Keys}
 import scala.cli.commands.util.CommonOps.SharedDirectoriesOptionsOps
 
-object Compile extends ScalaCommand[CompileOptions] {
+object Compile extends ScalaCommand[CompileOptions] with BuildCommandHelpers {
   override def group                                                         = "Main"
   override def sharedOptions(options: CompileOptions): Option[SharedOptions] = Some(options.shared)
 
-  def outputPath(options: CompileOptions): Option[os.Path] =
-    options.output.filter(_.nonEmpty).map(p => os.Path(p, Os.pwd))
-
   def run(options: CompileOptions, args: RemainingArgs): Unit = {
     maybePrintGroupHelp(options)
     maybePrintSimpleScalacOutput(options, options.shared.buildOptions())
@@ -71,8 +68,7 @@ object Compile extends ScalaCommand[CompileOptions] {
             val cp = s.fullClassPath.map(_.toString).mkString(File.pathSeparator)
             println(cp)
           }
-        for (output <- outputPath(options); s <- successulBuildOpt)
-          os.copy.over(s.output, output)
+        successulBuildOpt.foreach(_.copyOutput(options.shared))
       }
     }
 

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

@@ -84,6 +84,7 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
       ) { res =>
         res.orReport(logger).map(_.main).foreach {
           case s: Build.Successful =>
+            s.copyOutput(options.shared)
             val mtimeDestPath = doPackage(
               logger = logger,
               outputOpt = options.output.filter(_.nonEmpty),
@@ -123,6 +124,7 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
           .orExit(logger)
       builds.main match {
         case s: Build.Successful =>
+          s.copyOutput(options.shared)
           val res0 = doPackage(
             logger = logger,
             outputOpt = options.output.filter(_.nonEmpty),

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

@@ -222,6 +222,7 @@ object Run extends ScalaCommand[RunOptions] with BuildCommandHelpers {
             )
               .orReport(logger)
               .flatten
+            s.copyOutput(options.shared)
             if (options.sharedRun.watch.restart)
               processOpt = maybeProcess
             else
@@ -250,6 +251,7 @@ object Run extends ScalaCommand[RunOptions] with BuildCommandHelpers {
           .orExit(logger)
       builds.main match {
         case s: Build.Successful =>
+          s.copyOutput(options.shared)
           val res = maybeRun(
             s,
             allowTerminate = true,

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

@@ -2,9 +2,11 @@ package scala.cli.commands.util
 
 import scala.build.{Build, Logger}
 import scala.build.errors.MainClassError
-import scala.cli.commands.ScalaCommand
+import scala.cli.commands.{ScalaCommand, SharedOptions}
+import scala.build.Os
 
 trait BuildCommandHelpers { self: ScalaCommand[_] =>
+  import scala.cli.commands.util.ScalacOptionsUtil.*
   extension (successfulBuild: Build.Successful) {
     def retainedMainClass(
       logger: Logger,
@@ -15,5 +17,13 @@ trait BuildCommandHelpers { self: ScalaCommand[_] =>
         self.argvOpt.map(_.mkString(" ")).getOrElse(actualFullCommand),
         logger
       )
+
+    /** -O -d defaults to --compile-output; if both are defined, --compile-output takes precedence
+      */
+    def copyOutput(sharedOptions: SharedOptions): Unit =
+      sharedOptions.compilationOutput.filter(_.nonEmpty)
+        .orElse(sharedOptions.scalac.getForKey("-d").headOption)
+        .filter(_.nonEmpty)
+        .map(os.Path(_, Os.pwd)).foreach(output => os.copy.over(successfulBuild.output, output))
   }
 }

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

@@ -172,8 +172,10 @@ object SharedOptionsUtil extends CommandHelpers {
           scalacOptions = ShadowingSeq.from(
             scalac
               .scalacOptionKeyFilter(
-                _ != "-classpath"
-              ) // -O -classpath should be redirected as --extra-jars instead
+                // -O -classpath should be redirected as --extra-jars instead
+                // similarly for -O -d, it should be redirected as --compilation-output
+                key => key != "-classpath" && key != "-d"
+              )
               .filter(_.nonEmpty)
               .map(ScalacOpt(_))
               .map(Positioned.commandLine)

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

@@ -94,7 +94,9 @@ abstract class CompileTestDefinitions(val scalaVersionOpt: Option[String])
   test("copy compile output") {
     mainAndTestInputs.fromRoot { root =>
       val tempOutput = root / "output"
-      os.proc(TestUtil.cli, "compile", "--output", tempOutput, extraOptions, ".").call(cwd = root)
+      os.proc(TestUtil.cli, "compile", "--compile-output", tempOutput, extraOptions, ".").call(cwd =
+        root
+      )
       checkIfCompileOutputIsCopied("Main", tempOutput)
     }
   }
@@ -107,7 +109,7 @@ abstract class CompileTestDefinitions(val scalaVersionOpt: Option[String])
           TestUtil.cli,
           "compile",
           "--test",
-          "--output",
+          "--compile-output",
           tempOutput,
           "--print-class-path",
           extraOptions,

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

@@ -2251,9 +2251,36 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
         extraOptions
       ).call(cwd = root / runDir)
       expect(runRes.out.trim == expectedOutput)
+    }
+  }
+
+  test("-O -classpath allows to run with scala-cli compile -O -d option pre-compiled classes") {
+    val preCompileDir    = "PreCompileDir"
+    val preCompiledInput = "Message.scala"
+    val runDir           = "RunDir"
+    val mainInput        = "Main.scala"
+    val expectedOutput   = "Hello"
+    TestInputs(
+      os.rel / preCompileDir / preCompiledInput -> "case class Message(value: String)",
+      os.rel / runDir / mainInput -> s"""object Main extends App { println(Message("$expectedOutput").value) }"""
+    ).fromRoot { (root: os.Path) =>
+      val preCompileOutputDir = "out"
+
+      // first, precompile to an explicitly specified output directory with -O -d
+      val compileRes = os.proc(
+        TestUtil.cli,
+        "compile",
+        preCompiledInput,
+        "-O",
+        "-d",
+        "-O",
+        preCompileOutputDir,
+        extraOptions
+      ).call(cwd = root / preCompileDir, stderr = os.Pipe)
+      expect(!compileRes.err.trim.contains("Warning: Flag -d set repeatedly"))
 
-      // ensure the same behaviour can be expected when passing -classpath with -O
-      val runRes2 = os.proc(
+      // next, run while relying on the pre-compiled class, specifying the path with -O -classpath
+      val runRes = os.proc(
         TestUtil.cli,
         "run",
         mainInput,
@@ -2263,8 +2290,8 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
         (os.rel / os.up / preCompileDir / preCompileOutputDir).toString,
         extraOptions
       ).call(cwd = root / runDir, stderr = os.Pipe)
-      expect(!runRes2.err.trim.contains("Warning: Flag -classpath set repeatedly"))
-      expect(runRes2.out.trim == expectedOutput)
+      expect(!runRes.err.trim.contains("Warning: Flag -classpath set repeatedly"))
+      expect(runRes.out.trim == expectedOutput)
     }
   }
 

website/docs/reference/cli-options.md

@@ -119,12 +119,6 @@ Aliases: `-p`, `--print-classpath`
 
 Print the resulting class path
 
-### `--output`
-
-Aliases: `--output-directory`, `-d`, `--destination`
-
-Copy compilation results to output directory using either relative or absolute path
-
 ### `--test`
 
 Compile test scope
@@ -1286,6 +1280,12 @@ Add dependency for stubs needed to make $ivy and $dep imports to work.
 ### `--strict-bloop-json-check`
 
 [Internal]
+### `--compilation-output`
+
+Aliases: `--output-directory`, `-d`, `--destination`, `--compile-output`, `--compile-out`
+
+Copy compilation results to output directory using either relative or absolute path
+
 ## Snippet options
 
 Available in commands:

website/docs/reference/scala-command/cli-options.md

@@ -103,12 +103,6 @@ Aliases: `-p`, `--print-classpath`
 
 Print the resulting class path
 
-### `--output`
-
-Aliases: `--output-directory`, `-d`, `--destination`
-
-Copy compilation results to output directory using either relative or absolute path
-
 ### `--test`
 
 Compile test scope
@@ -696,6 +690,12 @@ Add dependency for stubs needed to make $ivy and $dep imports to work.
 ### `--strict-bloop-json-check`
 
 [Internal]
+### `--compilation-output`
+
+Aliases: `--output-directory`, `-d`, `--destination`, `--compile-output`, `--compile-out`
+
+Copy compilation results to output directory using either relative or absolute path
+
 ## Snippet options
 
 Available in commands: