Merge pull request #1238 from Gedochao/interactive-global

Enable turning `--interactive` mode on permanently

Author: Gedochao

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

@@ -8,23 +8,26 @@ import dependency.AnyDependency
 import dependency.parser.DependencyParser
 
 import java.io.{File, InputStream}
-
-import scala.build._
+import scala.build.*
 import scala.build.blooprifle.BloopRifleConfig
 import scala.build.compiler.{BloopCompilerMaker, ScalaCompilerMaker, SimpleScalaCompilerMaker}
 import scala.build.errors.BuildException
-import scala.build.internal.CsLoggerUtil._
+import scala.build.interactive.Interactive
+import scala.build.interactive.Interactive.{InteractiveAsk, InteractiveNop}
+import scala.build.internal.CsLoggerUtil.*
 import scala.build.internal.{Constants, FetchExternalBinary, OsLibc, Util}
 import scala.build.options.{Platform, ScalacOpt, ShadowingSeq}
-import scala.build.{options => bo}
+import scala.build.options as bo
 import scala.cli.commands.ScalaJsOptions
-import scala.cli.commands.util.CommonOps._
-import scala.cli.commands.util.SharedCompilationServerOptionsUtil._
-import scala.concurrent.duration._
+import scala.cli.commands.util.CommonOps.*
+import scala.cli.commands.util.SharedCompilationServerOptionsUtil.*
+import scala.cli.config.{ConfigDb, Keys}
+import scala.concurrent.ExecutionContextExecutorService
+import scala.concurrent.duration.*
 import scala.util.Properties
 import scala.util.control.NonFatal
 
-object SharedOptionsUtil {
+object SharedOptionsUtil extends CommandHelpers {
 
   private def downloadInputs(cache: FileCache[Task]): String => Either[String, Array[Byte]] = {
     url =>
@@ -62,7 +65,7 @@ object SharedOptionsUtil {
           logger.message(s"WARNING: provided resource directory path doesn't exist: $path")
         path
       }
-      .map(Inputs.ResourceDirectory(_))
+      .map(Inputs.ResourceDirectory)
     val maybeInputs = Inputs(
       args,
       Os.pwd,
@@ -91,7 +94,7 @@ object SharedOptionsUtil {
   implicit class SharedOptionsOps(v: SharedOptions) {
     import v._
 
-    def logger = logging.logger
+    def logger: Logger = logging.logger
 
     private def scalaJsOptions(opts: ScalaJsOptions): options.ScalaJsOptions = {
       import opts._
@@ -165,11 +168,11 @@ object SharedOptionsUtil {
             scalac.scalacOption
               .filter(_.nonEmpty)
               .map(ScalacOpt(_))
-              .map(Positioned.commandLine(_))
+              .map(Positioned.commandLine)
           ),
           compilerPlugins =
             SharedOptionsUtil.parseDependencies(
-              dependencies.compilerPlugin.map(Positioned.none(_)),
+              dependencies.compilerPlugin.map(Positioned.none),
               ignoreErrors
             ),
           platform = platformOpt.map(o => Positioned(List(Position.CommandLine()), o))
@@ -202,7 +205,7 @@ object SharedOptionsUtil {
           extraRepositories = dependencies.repository.map(_.trim).filter(_.nonEmpty),
           extraDependencies = ShadowingSeq.from(
             SharedOptionsUtil.parseDependencies(
-              dependencies.dependency.map(Positioned.none(_)),
+              dependencies.dependency.map(Positioned.none),
               ignoreErrors
             )
           )
@@ -212,16 +215,59 @@ object SharedOptionsUtil {
           localRepository = LocalRepo.localRepo(directories.directories.localRepoDir),
           verbosity = Some(logging.verbosity),
           strictBloopJsonCheck = strictBloopJsonCheck,
-          interactive = logging.verbosityOptions.interactive
+          interactive = Some(() => interactive)
         ),
         notForBloopOptions = bo.PostBuildOptions(
           scalaJsLinkerOptions = linkerOptions(js)
         )
       )
     }
 
+    def globalInteractiveWasSuggested: Option[Boolean] =
+      configDb.getOrNone(Keys.globalInteractiveWasSuggested, logger)
+
+    def interactive: Interactive =
+      (
+        logging.verbosityOptions.interactive,
+        configDb.getOrNone(Keys.interactive, logger),
+        globalInteractiveWasSuggested
+      ) match {
+        case (Some(true), _, Some(true)) => InteractiveAsk
+        case (_, Some(true), _)          => InteractiveAsk
+        case (Some(true), _, _) =>
+          val answers @ List(yesAnswer, _) = List("Yes", "No")
+          InteractiveAsk.chooseOne(
+            """You have run the current scala-cli command with the --interactive mode turned on.
+              |Would you like to leave it on permanently?""".stripMargin,
+            answers
+          ) match {
+            case Some(answer) if answer == yesAnswer =>
+              configDb
+                .set(Keys.interactive, true)
+                .set(Keys.globalInteractiveWasSuggested, true)
+                .save(v.directories.directories)
+              logger.message(
+                "--interactive is now set permanently. All future scala-cli commands will run with the flag set to true."
+              )
+              logger.message(
+                "If you want to turn this setting off at any point, just run `scala-cli config interactive false`."
+              )
+            case _ =>
+              configDb
+                .set(Keys.globalInteractiveWasSuggested, true)
+                .save(v.directories.directories)
+              logger.message(
+                "If you want to turn this setting permanently on at any point, just run `scala-cli config interactive true`."
+              )
+          }
+          InteractiveAsk
+        case _ => InteractiveNop
+      }
+
+    def configDb: ConfigDb = ConfigDb.open(v).orExit(logger)
+
     def downloadJvm(jvmId: String, options: bo.BuildOptions): String = {
-      implicit val ec = options.finalCache.ec
+      implicit val ec: ExecutionContextExecutorService = options.finalCache.ec
       val javaHomeManager = options.javaHomeManager
         .withMessage(s"Downloading JVM $jvmId")
       val logger = javaHomeManager.cache
@@ -306,7 +352,7 @@ object SharedOptionsUtil {
         !Properties.isWin
       )
 
-    def strictBloopJsonCheckOrDefault =
+    def strictBloopJsonCheckOrDefault: Boolean =
       strictBloopJsonCheck.getOrElse(bo.InternalOptions.defaultStrictBloopJsonCheck)
   }
 

modules/cli/src/main/scala/scala/cli/config/ConfigDb.scala

@@ -1,13 +1,14 @@
 package scala.cli.config
 
-import com.github.plokhotnyuk.jsoniter_scala.core.{Key => _, _}
-import com.github.plokhotnyuk.jsoniter_scala.macros._
+import com.github.plokhotnyuk.jsoniter_scala.core.{Key as _, *}
+import com.github.plokhotnyuk.jsoniter_scala.macros.*
 import coursier.parse.RawJson
 
 import java.nio.file.attribute.PosixFilePermission
-
-import scala.build.Directories
+import scala.build.{Directories, Logger}
 import scala.build.errors.BuildException
+import scala.cli.commands.SharedOptions
+import scala.cli.commands.util.CommonOps.SharedDirectoriesOptionsOps
 import scala.collection.immutable.ListMap
 import scala.util.Properties
 
@@ -42,6 +43,19 @@ final class ConfigDb private (
           .map(Some(_))
     }
 
+  /** Gets an entry.
+    *
+    * If the value cannot be decoded or the key isn't in the DB, None is returned.
+    *
+    * Otherwise, the value is returned wrapped in Some.
+    */
+  def getOrNone[T](key: Key[T], logger: Logger): Option[T] = get[T](key) match {
+    case Right(maybeValue) => maybeValue
+    case Left(ex) =>
+      logger.debug(ex)
+      None
+  }
+
   /** Sets an entry in memory */
   def set[T](key: Key[T], value: T): this.type = {
     val b = key.write(value)
@@ -225,6 +239,16 @@ object ConfigDb {
   def open(directories: Directories): Either[BuildException, ConfigDb] =
     open(dbPath(directories))
 
+  /** Creates a ConfigDb from Scala CLI [[scala.cli.commands.SharedOptions]]
+    *
+    * @param sharedOptions:
+    *   a Scala CLI shared options instance
+    * @return
+    *   either an error on failure, or a ConfigDb instance on success
+    */
+  def open(sharedOptions: SharedOptions): Either[BuildException, ConfigDb] =
+    open(sharedOptions.directories.directories)
+
   def empty: ConfigDb =
     new ConfigDb(Map())
 }

modules/cli/src/main/scala/scala/cli/config/Keys.scala

@@ -17,7 +17,14 @@ object Keys {
 
   val actions = new Key.BooleanEntry(Seq.empty, "actions")
 
-  def all = Seq[Key[_]](
+  val interactive = new Key.BooleanEntry(Seq.empty, "interactive")
+
+  // setting indicating if the global interactive mode was suggested
+  val globalInteractiveWasSuggested = new Key.BooleanEntry(Seq.empty, "interactive-was-suggested")
+
+  def all: Seq[Key[_]] = Seq[Key[_]](
+    interactive,
+    globalInteractiveWasSuggested,
     actions,
     userName,
     userEmail,
@@ -30,6 +37,6 @@ object Keys {
     sonatypePassword
   )
 
-  lazy val map = all.map(e => e.fullName -> e).toMap
+  lazy val map: Map[String, Key[_]] = all.map(e => e.fullName -> e).toMap
 
 }

modules/options/src/main/scala/scala/build/options/BuildOptions.scala

@@ -170,10 +170,10 @@ final case class BuildOptions(
     else None
   }
 
-  lazy val finalCache = internal.cache.getOrElse(FileCache())
+  lazy val finalCache: FileCache[Task] = internal.cache.getOrElse(FileCache())
   // This might download a JVM if --jvm … is passed or no system JVM is installed
 
-  lazy val archiveCache = ArchiveCache().withCache(finalCache)
+  lazy val archiveCache: ArchiveCache[Task] = ArchiveCache().withCache(finalCache)
 
   private lazy val javaCommand0: Positioned[JavaHomeInfo] = javaHomeLocation().map { javaHome =>
     val (javaVersion, javaCmd) = OsLibc.javaHomeVersion(javaHome)
@@ -599,8 +599,7 @@ final case class BuildOptions(
     }
   }
 
-  val interactive: Interactive =
-    if (internal.interactive.getOrElse(false)) InteractiveAsk else InteractiveNop
+  lazy val interactive: Interactive = internal.interactive.getOrElse(() => InteractiveNop)()
 }
 
 object BuildOptions {

modules/options/src/main/scala/scala/build/options/InternalOptions.scala

@@ -4,6 +4,8 @@ import coursier.cache.FileCache
 import coursier.util.Task
 
 import scala.build.Positioned
+import scala.build.interactive.Interactive
+import scala.build.interactive.Interactive.InteractiveNop
 
 final case class InternalOptions(
   keepDiagnostics: Boolean = false,
@@ -12,7 +14,7 @@ final case class InternalOptions(
   verbosity: Option[Int] = None,
   // FIXME Should be removed, not a real option (not meant to be set from using directives)
   strictBloopJsonCheck: Option[Boolean] = None,
-  interactive: Option[Boolean] = None,
+  interactive: Option[() => Interactive] = None,
   javaClassNameVersionOpt: Option[String] = None,
   /** Whether to keep the coursier.Resolution instance in [[scala.build.Artifacts]]
     *
@@ -23,8 +25,8 @@ final case class InternalOptions(
   keepResolution: Boolean = false,
   extraSourceFiles: Seq[Positioned[os.Path]] = Nil
 ) {
-  def verbosityOrDefault = verbosity.getOrElse(0)
-  def strictBloopJsonCheckOrDefault =
+  def verbosityOrDefault: Int = verbosity.getOrElse(0)
+  def strictBloopJsonCheckOrDefault: Boolean =
     strictBloopJsonCheck.getOrElse(InternalOptions.defaultStrictBloopJsonCheck)
 }