Setup-ide should run before compile, run and test (#188)

* Setup-ide should run before compile, run and test

Co-authored-by: Alexandre Archambault <[email protected]>

Co-authored-by: Alexandre Archambault <[email protected]>

* Rewrite imports

* Absolute paths, ide-options.json and runSafe

* Apply suggestions from code review

Co-authored-by: Alexandre Archambault <[email protected]>

* Try making scala-cli in bsp absolute, bring back test

* Greedy algorithm for dropping urls

* Update modules/integration/src/test/scala/scala/cli/integration/BspTestDefinitions.scala

Co-authored-by: Alexandre Archambault <[email protected]>

* Make paths absolute if they exist

* Add coursier.mainJar and fallback to current class location

* NIT

* fixup

* Don't run setup-ide for virtual inputs

And don't re-parse the input arguments, just use what's in the Inputs
instance.

* Update tests

* fixup

* fixup

* fixup

Co-authored-by: Alexandre Archambault <[email protected]>
Co-authored-by: Alexandre Archambault <[email protected]>

Author: MarcinAman

build.sc

@@ -285,7 +285,8 @@ trait Cli extends SbtModule with CliLaunchers with ScalaCliPublishModule with Fo
     Deps.jniUtils,
     Deps.scalaJsLinker,
     Deps.scalaPackager,
-    Deps.svmSubs
+    Deps.svmSubs,
+    Deps.upickle
   )
   def compileIvyDeps = super.compileIvyDeps() ++ Agg(
     Deps.svm

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

@@ -1,9 +1,11 @@
 package scala.cli.commands
 
 import caseapp._
+import upickle.default._
 
 import scala.build.Build
 import scala.build.bsp.BspThreads
+import scala.build.options.BuildOptions
 import scala.concurrent.Await
 import scala.concurrent.duration.Duration
 
@@ -13,21 +15,27 @@ object Bsp extends ScalaCommand[BspOptions] {
     if (options.shared.logging.verbosity >= 3)
       pprint.stderr.log(args)
 
-    val buildOptions     = options.buildOptions
-    val bloopRifleConfig = options.shared.bloopRifleConfig()
-    val logger           = options.shared.logging.logger
+    val sharedOptions: SharedOptions =
+      options.jsonOptions.map { optionsPath =>
+        val source = os.read(os.Path(optionsPath, os.pwd))
+        read[SharedOptions](source)
+      }.getOrElse(options.shared)
+
+    val buildOptionsToUse = buildOptions(sharedOptions)
+    val bloopRifleConfig  = sharedOptions.bloopRifleConfig()
+    val logger            = sharedOptions.logging.logger
 
     val inputs = {
       val initialInputs = options.shared.inputsOrExit(args)
       if (options.shared.logging.verbosity >= 3)
         pprint.stderr.log(initialInputs)
-      Build.updateInputs(initialInputs, buildOptions)
+      Build.updateInputs(initialInputs, buildOptionsToUse)
     }
 
     BspThreads.withThreads { threads =>
       val bsp = scala.build.bsp.Bsp.create(
         inputs,
-        buildOptions,
+        buildOptionsToUse,
         logger,
         bloopRifleConfig,
         options.shared.logging.verbosity,
@@ -43,4 +51,20 @@ object Bsp extends ScalaCommand[BspOptions] {
       finally bsp.shutdown()
     }
   }
+
+  private def buildOptions(sharedOptions: SharedOptions): BuildOptions = {
+    val baseOptions = sharedOptions.buildOptions(enableJmh = false, jmhVersion = None)
+    baseOptions.copy(
+      classPathOptions = baseOptions.classPathOptions.copy(
+        fetchSources = baseOptions.classPathOptions.fetchSources.orElse(Some(true))
+      ),
+      scalaOptions = baseOptions.scalaOptions.copy(
+        generateSemanticDbs = baseOptions.scalaOptions.generateSemanticDbs.orElse(Some(true))
+      ),
+      internalDependencies = baseOptions.internalDependencies.copy(
+        addRunnerDependencyOpt =
+          baseOptions.internalDependencies.addRunnerDependencyOpt.orElse(Some(false))
+      )
+    )
+  }
 }

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

@@ -2,31 +2,18 @@ package scala.cli.commands
 
 import caseapp._
 
-import scala.build.options.BuildOptions
-
 // format: off
 final case class BspOptions(
   // FIXME There might be too many options in SharedOptions for the bsp command…
   @Recurse
-    shared: SharedOptions = SharedOptions()
+    shared: SharedOptions = SharedOptions(),
+  
+  @HelpMessage("Command-line options JSON file")
+  @ValueDescription("path")
+  @Hidden
+  jsonOptions: Option[String] = None
 ) {
   // format: on
-
-  def buildOptions: BuildOptions = {
-    val baseOptions = shared.buildOptions(enableJmh = false, jmhVersion = None)
-    baseOptions.copy(
-      classPathOptions = baseOptions.classPathOptions.copy(
-        fetchSources = baseOptions.classPathOptions.fetchSources.orElse(Some(true))
-      ),
-      scalaOptions = baseOptions.scalaOptions.copy(
-        generateSemanticDbs = baseOptions.scalaOptions.generateSemanticDbs.orElse(Some(true))
-      ),
-      internalDependencies = baseOptions.internalDependencies.copy(
-        addRunnerDependencyOpt =
-          baseOptions.internalDependencies.addRunnerDependencyOpt.orElse(Some(false))
-      )
-    )
-  }
 }
 
 object BspOptions {

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

@@ -10,8 +10,14 @@ object Compile extends ScalaCommand[CompileOptions] {
   override def group                                  = "Main"
   override def sharedOptions(options: CompileOptions) = Some(options.shared)
   def run(options: CompileOptions, args: RemainingArgs): Unit = {
-
     val inputs = options.shared.inputsOrExit(args)
+    val logger = options.shared.logger
+    SetupIde.runSafe(
+      options.shared,
+      inputs,
+      logger,
+      Some(name)
+    )
 
     val cross = options.cross.cross.getOrElse(false)
     if (options.classPath && cross) {
@@ -48,8 +54,6 @@ object Compile extends ScalaCommand[CompileOptions] {
     val buildOptions     = options.buildOptions
     val bloopRifleConfig = options.shared.bloopRifleConfig()
 
-    val logger = options.shared.logger
-
     if (options.watch.watch) {
       val watcher = Build.watch(
         inputs,

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

@@ -2,6 +2,7 @@ package scala.cli.commands
 
 import caseapp._
 import coursier.cache.{CacheLogger, FileCache}
+import upickle.default.{ReadWriter, macroRW}
 
 import scala.concurrent.duration.Duration
 
@@ -26,4 +27,5 @@ object CoursierOptions {
   lazy val parser: Parser[CoursierOptions]                           = Parser.derive
   implicit lazy val parserAux: Parser.Aux[CoursierOptions, parser.D] = parser
   implicit lazy val help: Help[CoursierOptions]                      = Help.derive
+  implicit lazy val jsonCodec: ReadWriter[CoursierOptions]           = macroRW
 }

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

@@ -1,6 +1,7 @@
 package scala.cli.commands
 
 import caseapp._
+import upickle.default.{ReadWriter => RW, _}
 
 import scala.build.Logger
 import scala.cli.internal.CliLogger
@@ -32,4 +33,9 @@ object LoggingOptions {
   lazy val parser: Parser[LoggingOptions]                           = Parser.derive
   implicit lazy val parserAux: Parser.Aux[LoggingOptions, parser.D] = parser
   implicit lazy val help: Help[LoggingOptions]                      = Help.derive
+  implicit val rwCounter: RW[Int @@ Counter] = readwriter[ujson.Value].bimap[Int @@ Counter](
+    x => ujson.Num(Tag.unwrap(x)),
+    json => Tag.of(json.num.toInt)
+  )
+  implicit val rw: RW[LoggingOptions] = macroRW
 }

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

@@ -20,7 +20,6 @@ object Run extends ScalaCommand[RunOptions] {
     run(options, args, () => Inputs.default())
 
   def run(options: RunOptions, args: RemainingArgs, defaultInputs: () => Option[Inputs]): Unit = {
-
     val inputs = options.shared.inputsOrExit(args, defaultInputs = defaultInputs)
 
     val initialBuildOptions = options.buildOptions
@@ -40,6 +39,12 @@ object Run extends ScalaCommand[RunOptions] {
       )
 
     val cross = options.compileCross.cross.getOrElse(false)
+    SetupIde.runSafe(
+      options.shared,
+      inputs,
+      logger,
+      Some(name)
+    )
 
     if (options.watch.watch) {
       val watcher = Build.watch(

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

@@ -1,6 +1,7 @@
 package scala.cli.commands
 
 import caseapp._
+import upickle.default.{ReadWriter, macroRW}
 
 import scala.build.options
 
@@ -43,4 +44,5 @@ object ScalaJsOptions {
   lazy val parser: Parser[ScalaJsOptions]                           = Parser.derive
   implicit lazy val parserAux: Parser.Aux[ScalaJsOptions, parser.D] = parser
   implicit lazy val help: Help[ScalaJsOptions]                      = Help.derive
+  implicit lazy val jsonCodec: ReadWriter[ScalaJsOptions]           = macroRW
 }

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

@@ -1,6 +1,7 @@
 package scala.cli.commands
 
 import caseapp._
+import upickle.default.{ReadWriter, macroRW}
 
 import scala.build.options
 
@@ -55,4 +56,5 @@ object ScalaNativeOptions {
   lazy val parser: Parser[ScalaNativeOptions]                           = Parser.derive
   implicit lazy val parserAux: Parser.Aux[ScalaNativeOptions, parser.D] = parser
   implicit lazy val help: Help[ScalaNativeOptions]                      = Help.derive
+  implicit lazy val jsonCodec: ReadWriter[ScalaNativeOptions]           = macroRW
 }

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

@@ -4,6 +4,7 @@ import caseapp._
 import caseapp.core.Arg
 import caseapp.core.parser.{Argument, NilParser, StandardArgument}
 import caseapp.core.util.Formatter
+import upickle.default.{ReadWriter, macroRW}
 
 // format: off
 final case class ScalacOptions(
@@ -53,5 +54,6 @@ object ScalacOptions {
         NilParser
     baseParser.to[ScalacOptions]
   }
-  implicit lazy val help: Help[SharedOptions] = Help.derive
+  implicit lazy val help: Help[SharedOptions]            = Help.derive
+  implicit lazy val jsonCodec: ReadWriter[ScalacOptions] = macroRW
 }