Refactor: put all used environment variable keys in a common util with descriptions

Gedochao · Gedochao · commit 420555420ba7 · 2024-08-01T14:36:14.000+02:00
diff --git a/modules/build/src/main/scala/scala/build/Directories.scala b/modules/build/src/main/scala/scala/build/Directories.scala
@@ -4,6 +4,7 @@ import coursier.cache.shaded.dirs.{GetWinDirs, ProjectDirectories}
 
 import scala.build.errors.ConfigDbException
 import scala.build.internal.JniGetWinDirs
+import scala.build.internals.EnvsUtil
 import scala.cli.config.ConfigDb
 import scala.util.Properties
 
@@ -19,7 +20,7 @@ trait Directories {
   def cacheDir: os.Path
 
   final def dbPath: os.Path =
-    Option(System.getenv("SCALA_CLI_CONFIG"))
+    EnvsUtil.EnvVar.ScalaCli.config.valueOpt
       .filter(_.trim.nonEmpty)
       .map(os.Path(_, os.pwd))
       .getOrElse(secretsDir / Directories.defaultDbFileName)
@@ -95,7 +96,7 @@ object Directories {
     SubDir(dir)
 
   lazy val directories: Directories =
-    Option(System.getenv("SCALA_CLI_HOME")).filter(_.trim.nonEmpty) match {
+    EnvsUtil.EnvVar.ScalaCli.home.valueOpt.filter(_.trim.nonEmpty) match {
       case None =>
         scala.build.Directories.default()
       case Some(homeDir) =>
diff --git a/modules/build/src/main/scala/scala/build/internal/Runner.scala b/modules/build/src/main/scala/scala/build/internal/Runner.scala
@@ -12,6 +12,7 @@ import java.nio.file.{Files, Path, Paths}
 import scala.build.EitherCps.{either, value}
 import scala.build.Logger
 import scala.build.errors._
+import scala.build.internals.EnvsUtil
 import scala.build.testrunner.{AsmTestRunner, TestRunner}
 import scala.util.{Failure, Properties, Success}
 
@@ -191,12 +192,12 @@ object Runner {
     if (Paths.get(app).getNameCount >= 2) Some(asIs)
     else {
       def pathEntries =
-        Option(System.getenv("PATH"))
+        EnvsUtil.EnvVar.Misc.path.valueOpt
           .iterator
           .flatMap(_.split(File.pathSeparator).iterator)
       def pathSep =
         if (Properties.isWin)
-          Option(System.getenv("PATHEXT"))
+          EnvsUtil.EnvVar.Misc.pathExt.valueOpt
             .iterator
             .flatMap(_.split(File.pathSeparator).iterator)
         else Iterator("")
diff --git a/modules/build/src/main/scala/scala/build/internal/zip/WrappedZipInputStream.scala b/modules/build/src/main/scala/scala/build/internal/zip/WrappedZipInputStream.scala
@@ -3,6 +3,8 @@ package scala.build.internal.zip
 import java.io.{Closeable, InputStream}
 import java.util.zip.ZipEntry
 
+import scala.build.internals.EnvsUtil
+
 /*
  * juz.ZipInputStream is buggy on Arch Linux from native images (CRC32 calculation issues,
  * see oracle/graalvm#4479), so we use a custom ZipInputStream with disabled CRC32 calculation.
@@ -35,7 +37,7 @@ object WrappedZipInputStream {
         case "true" | "1" => true
         case _            => false
       }
-    Option(System.getenv("SCALA_CLI_VENDORED_ZIS")).map(toBoolean)
+    EnvsUtil.EnvVar.ScalaCli.vendoredZipInputStream.valueOpt.map(toBoolean)
       .orElse(sys.props.get("scala-cli.zis.vendored").map(toBoolean))
       .getOrElse(false)
   }
diff --git a/modules/build/src/test/scala/scala/build/tests/util/BloopServer.scala b/modules/build/src/test/scala/scala/build/tests/util/BloopServer.scala
@@ -3,6 +3,7 @@ package scala.build.tests.util
 import bloop.rifle.BloopRifleConfig
 import coursier.cache.FileCache
 
+import scala.build.internals.EnvsUtil
 import scala.build.{Bloop, Logger}
 import scala.util.Properties
 
@@ -30,7 +31,7 @@ object BloopServer {
           // which can have issues with the directory of "java" in the PATH,
           // if it contains '+' or '%' IIRC.
           // So we hardcode the path to "java" here.
-          Option(System.getenv("JAVA_HOME"))
+          EnvsUtil.EnvVar.Java.javaHome.valueOpt
             .map(os.Path(_, os.pwd))
             .map(_ / "bin" / "java")
             .map(_.toString)
diff --git a/modules/cli/src/main/scala/scala/cli/ScalaCli.scala b/modules/cli/src/main/scala/scala/cli/ScalaCli.scala
@@ -11,6 +11,7 @@ import java.util.Locale
 
 import scala.build.Directories
 import scala.build.internal.Constants
+import scala.build.internals.EnvsUtil
 import scala.cli.config.{ConfigDb, Keys}
 import scala.cli.internal.Argv0
 import scala.cli.javaLauncher.JavaLauncherCli
@@ -45,7 +46,7 @@ object ScalaCli {
       powerEntry <- configDb.get(Keys.power).toOption
       power      <- powerEntry
     } yield power
-    val isPowerEnv = Option(System.getenv("SCALA_CLI_POWER")).flatMap(_.toBooleanOption)
+    val isPowerEnv = EnvsUtil.EnvVar.ScalaCli.power.valueOpt.flatMap(_.toBooleanOption)
     val isPower    = isPowerEnv.orElse(isPowerConfigDb).getOrElse(false)
     !isPower
   }
@@ -94,8 +95,8 @@ object ScalaCli {
     baos.toByteArray
   }
 
-  private def isCI = System.getenv("CI") != null
-  private def printStackTraces = Option(System.getenv("SCALA_CLI_PRINT_STACK_TRACES"))
+  private def isCI = EnvsUtil.EnvVar.Internal.ci.valueOpt.nonEmpty
+  private def printStackTraces = EnvsUtil.EnvVar.ScalaCli.printStackTraces.valueOpt
     .map(_.toLowerCase(Locale.ROOT))
     .exists {
       case "true" | "1" => true
@@ -157,7 +158,7 @@ object ScalaCli {
             // for https://github.com/VirtusLab/scala-cli/issues/828
             System.err.println(
               s"""Running
-                 |  export SCALA_CLI_VENDORED_ZIS=true
+                 |  export ${EnvsUtil.EnvVar.ScalaCli.vendoredZipInputStream.name}=true
                  |before running $fullRunnerName might fix the issue.
                  |""".stripMargin
             )
@@ -209,7 +210,8 @@ object ScalaCli {
       }
 
     // load java properties from JAVA_OPTS and JDK_JAVA_OPTIONS environment variables
-    val javaOpts = sys.env.get("JAVA_OPTS").toSeq ++ sys.env.get("JDK_JAVA_OPTIONS").toSeq
+    val javaOpts: Seq[String] =
+      EnvsUtil.EnvVar.Java.javaOpts.valueOpt.toSeq ++ EnvsUtil.EnvVar.Java.jdkJavaOpts.valueOpt.toSeq
 
     val ignoredJavaOpts =
       javaOpts
@@ -224,7 +226,8 @@ object ScalaCli {
         }.flatten
     if ignoredJavaOpts.nonEmpty then
       System.err.println(
-        s"Warning: Only java properties are supported in JAVA_OPTS and JDK_JAVA_OPTIONS environment variables. Other options are ignored: ${ignoredJavaOpts.mkString(", ")}"
+        s"Warning: Only java properties are supported in ${EnvsUtil.EnvVar.Java.javaOpts.name} and ${EnvsUtil.EnvVar
+            .Java.jdkJavaOpts.name} environment variables. Other options are ignored: ${ignoredJavaOpts.mkString(", ")}"
       )
   }
 
diff --git a/modules/cli/src/main/scala/scala/cli/commands/addpath/AddPath.scala b/modules/cli/src/main/scala/scala/cli/commands/addpath/AddPath.scala
@@ -6,6 +6,7 @@ import coursier.env.{EnvironmentUpdate, ProfileUpdater}
 import java.io.File
 
 import scala.build.Logger
+import scala.build.internals.EnvsUtil
 import scala.cli.CurrentParams
 import scala.cli.commands.{CustomWindowsEnvVarUpdater, ScalaCommand}
 import scala.util.Properties
@@ -16,7 +17,10 @@ object AddPath extends ScalaCommand[AddPathOptions] {
   override def runCommand(options: AddPathOptions, args: RemainingArgs, logger: Logger): Unit = {
     if args.all.isEmpty then logger.error("Nothing to do")
     else {
-      val update = EnvironmentUpdate(Nil, Seq("PATH" -> args.all.mkString(File.pathSeparator)))
+      val update = EnvironmentUpdate(
+        Nil,
+        Seq(EnvsUtil.EnvVar.Misc.path.name -> args.all.mkString(File.pathSeparator))
+      )
       val didUpdate =
         if (Properties.isWin) {
           val updater = CustomWindowsEnvVarUpdater().withUseJni(Some(coursier.paths.Util.useJni()))
diff --git a/modules/cli/src/main/scala/scala/cli/commands/bsp/Bsp.scala b/modules/cli/src/main/scala/scala/cli/commands/bsp/Bsp.scala
@@ -9,6 +9,7 @@ import scala.build.*
 import scala.build.bsp.{BspReloadableOptions, BspThreads}
 import scala.build.errors.BuildException
 import scala.build.input.Inputs
+import scala.build.internals.EnvsUtil
 import scala.build.options.{BuildOptions, Scope}
 import scala.cli.commands.ScalaCommand
 import scala.cli.commands.publish.ConfigUtil.*
@@ -63,7 +64,7 @@ object Bsp extends ScalaCommand[BspOptions] {
       .flatMap(_.get(Keys.power).toOption)
       .flatten
       .getOrElse(false)
-    val envPowerMode       = latestEnvs.get("SCALA_CLI_POWER").exists(_.toBoolean)
+    val envPowerMode       = latestEnvs.get(EnvsUtil.EnvVar.ScalaCli.power.name).exists(_.toBoolean)
     val launcherPowerArg   = latestLauncherOptions.powerOptions.power
     val subCommandPowerArg = latestSharedOptions.powerOptions.power
     val latestPowerMode = configPowerMode || launcherPowerArg || subCommandPowerArg || envPowerMode
@@ -208,7 +209,7 @@ object Bsp extends ScalaCommand[BspOptions] {
           baseOptions.notForBloopOptions.addRunnerDependencyOpt.orElse(Some(false))
       )
     )
-    val withEnvs = envs.get("JAVA_HOME")
+    val withEnvs = envs.get(EnvsUtil.EnvVar.Java.javaHome.name)
       .filter(_ => withDefaults.javaOptions.javaHomeOpt.isEmpty)
       .map(javaHome =>
         withDefaults.copy(javaOptions =
diff --git a/modules/cli/src/main/scala/scala/cli/commands/github/LibSodiumJni.scala b/modules/cli/src/main/scala/scala/cli/commands/github/LibSodiumJni.scala
@@ -12,7 +12,8 @@ import scala.build.EitherCps.{either, value}
 import scala.build.Logger
 import scala.build.errors.BuildException
 import scala.build.internal.{Constants, FetchExternalBinary}
-import scala.cli.internal.{Constants => CliConstants}
+import scala.build.internals.EnvsUtil
+import scala.cli.internal.Constants as CliConstants
 import scala.util.Properties
 import scala.util.control.NonFatal
 
@@ -135,7 +136,7 @@ object LibSodiumJni {
         case Some(sodiumLib) =>
           System.load(sodiumLib.toString)
         case None =>
-          val allow = Option(System.getenv("SCALA_CLI_SODIUM_JNI_ALLOW"))
+          val allow = EnvsUtil.EnvVar.ScalaCli.allowSodiumJni.valueOpt
             .map(_.toLowerCase(Locale.ROOT))
             .forall {
               case "false" | "0" => false
diff --git a/modules/cli/src/main/scala/scala/cli/commands/installcompletions/InstallCompletions.scala b/modules/cli/src/main/scala/scala/cli/commands/installcompletions/InstallCompletions.scala
@@ -9,6 +9,7 @@ import java.nio.charset.Charset
 import java.nio.file.Paths
 import java.util
 
+import scala.build.internals.EnvsUtil
 import scala.build.{Directories, Logger}
 import scala.cli.commands.shared.HelpGroup
 import scala.cli.commands.{ScalaCommand, SpecificationLevel}
@@ -57,7 +58,7 @@ object InstallCompletions extends ScalaCommand[InstallCompletionsOptions] {
         (script, defaultRcFile)
       case Zsh.id | "zsh" =>
         val completionScript = Zsh.script(name)
-        val zDotDir = Option(System.getenv("ZDOTDIR"))
+        val zDotDir = EnvsUtil.EnvVar.Misc.zDotDir.valueOpt
           .map(os.Path(_, os.pwd))
           .getOrElse(os.home)
         val defaultRcFile        = zDotDir / ".zshrc"
@@ -114,7 +115,7 @@ object InstallCompletions extends ScalaCommand[InstallCompletionsOptions] {
   def getFormat(format: Option[String]): Option[String] =
     format.map(_.trim).filter(_.nonEmpty)
       .orElse {
-        Option(System.getenv("SHELL")).map(_.split("[\\/]+").last).map {
+        EnvsUtil.EnvVar.Misc.shell.valueOpt.map(_.split("[\\/]+").last).map {
           case "bash" => Bash.id
           case "zsh"  => Zsh.id
           case other  => other
diff --git a/modules/cli/src/main/scala/scala/cli/commands/publish/PublishParamsOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/publish/PublishParamsOptions.scala
@@ -2,6 +2,7 @@ package scala.cli.commands.publish
 
 import caseapp.*
 
+import scala.build.internals.EnvsUtil
 import scala.cli.commands.shared.{HelpGroup, SharedVersionOptions}
 import scala.cli.commands.tags
 import scala.cli.signing.shared.PasswordOption
@@ -77,10 +78,8 @@ final case class PublishParamsOptions(
 ) {
   // format: on
 
-  def setupCi: Boolean =
-    ci.getOrElse(false)
-  def isCi: Boolean =
-    ci.getOrElse(System.getenv("CI") != null)
+  def setupCi: Boolean = ci.getOrElse(false)
+  def isCi: Boolean    = ci.getOrElse(EnvsUtil.EnvVar.Internal.ci.valueOpt.nonEmpty)
 }
 
 object PublishParamsOptions {
diff --git a/modules/cli/src/main/scala/scala/cli/commands/run/Run.scala b/modules/cli/src/main/scala/scala/cli/commands/run/Run.scala
@@ -15,6 +15,7 @@ import scala.build.errors.BuildException
 import scala.build.input.{Inputs, ScalaCliInvokeData, SubCommand}
 import scala.build.internal.util.ConsoleUtils.ScalaCliConsole
 import scala.build.internal.{Constants, Runner, ScalaJsLinkerConfig}
+import scala.build.internals.EnvsUtil
 import scala.build.options.{BuildOptions, JavaOpt, PackageType, Platform, ScalacOpt}
 import scala.cli.CurrentParams
 import scala.cli.commands.package0.Package
@@ -498,9 +499,9 @@ object Run extends ScalaCommand[RunOptions] with BuildCommandHelpers {
           if (pythonLibraryPaths.isEmpty) Map.empty
           else {
             val prependTo =
-              if (Properties.isWin) "PATH"
-              else if (Properties.isMac) "DYLD_LIBRARY_PATH"
-              else "LD_LIBRARY_PATH"
+              if (Properties.isWin) EnvsUtil.EnvVar.Misc.path.name
+              else if (Properties.isMac) EnvsUtil.EnvVar.Misc.dyldLibraryPath.name
+              else EnvsUtil.EnvVar.Misc.ldLibraryPath.name
             val currentOpt = Option(System.getenv(prependTo))
             val currentEntries = currentOpt
               .map(_.split(File.pathSeparator).toSet)
diff --git a/modules/cli/src/main/scala/scala/cli/commands/shared/CoursierOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/shared/CoursierOptions.scala
@@ -5,6 +5,7 @@ import com.github.plokhotnyuk.jsoniter_scala.core.*
 import com.github.plokhotnyuk.jsoniter_scala.macros.*
 import coursier.cache.{CacheLogger, CachePolicy, FileCache}
 
+import scala.build.internals.EnvsUtil
 import scala.cli.commands.tags
 import scala.concurrent.duration.Duration
 
@@ -54,7 +55,7 @@ final case class CoursierOptions(
   }
 
   def getOffline(): Option[Boolean] = offline
-    .orElse(Option(System.getenv("COURSIER_MODE")).map(_ == "offline"))
+    .orElse(EnvsUtil.EnvVar.Coursier.coursierMode.valueOpt.map(_ == "offline"))
     .orElse(Option(System.getProperty("coursier.mode")).map(_ == "offline"))
 }
 
diff --git a/modules/cli/src/main/scala/scala/cli/commands/uninstallcompletions/UninstallCompletions.scala b/modules/cli/src/main/scala/scala/cli/commands/uninstallcompletions/UninstallCompletions.scala
@@ -6,6 +6,7 @@ import caseapp.core.help.HelpFormat
 import java.nio.charset.Charset
 
 import scala.build.Logger
+import scala.build.internals.EnvsUtil
 import scala.cli.CurrentParams
 import scala.cli.commands.installcompletions.InstallCompletions
 import scala.cli.commands.shared.HelpGroup
@@ -31,7 +32,7 @@ object UninstallCompletions extends ScalaCommand[UninstallCompletionsOptions] {
   ): Unit = {
     val name = InstallCompletions.getName(options.shared.name)
 
-    val zDotDir = Option(System.getenv("ZDOTDIR"))
+    val zDotDir = EnvsUtil.EnvVar.Misc.zDotDir.valueOpt
       .map(os.Path(_, os.pwd))
       .getOrElse(os.home)
     val rcFiles = options.shared.rcFile.map(file => Seq(os.Path(file, os.pwd))).getOrElse(Seq(
diff --git a/modules/cli/src/main/scala/scala/cli/commands/util/RunSpark.scala b/modules/cli/src/main/scala/scala/cli/commands/util/RunSpark.scala
@@ -3,8 +3,9 @@ package scala.cli.commands.util
 import scala.build.EitherCps.{either, value}
 import scala.build.errors.BuildException
 import scala.build.internal.Runner
+import scala.build.internals.EnvsUtil
 import scala.build.{Build, Logger}
-import scala.cli.commands.package0.{Package => PackageCmd}
+import scala.cli.commands.package0.Package as PackageCmd
 import scala.cli.commands.packaging.Spark
 import scala.cli.commands.run.RunMode
 import scala.cli.packaging.Library
@@ -32,7 +33,7 @@ object RunSpark {
     val javaOpts     = build.options.javaOptions.javaOpts.toSeq.map(_.value.value)
     val ext          = if (Properties.isWin) ".cmd" else ""
     val submitCommand: String =
-      Option(System.getenv("SPARK_HOME"))
+      EnvsUtil.EnvVar.Spark.sparkHome.valueOpt
         .map(os.Path(_, os.pwd))
         .map(_ / "bin" / s"spark-submit$ext")
         .filter(os.exists(_))
diff --git a/modules/cli/src/main/scala/scala/cli/internal/ProcUtil.scala b/modules/cli/src/main/scala/scala/cli/internal/ProcUtil.scala
@@ -5,6 +5,7 @@ import java.nio.charset.StandardCharsets
 import java.util.concurrent.{CancellationException, CompletableFuture, CompletionException}
 
 import scala.build.Logger
+import scala.build.internals.EnvsUtil
 import scala.util.control.NonFatal
 import scala.util.{Properties, Try}
 
@@ -73,8 +74,8 @@ object ProcUtil {
   def findApplicationPathsOnPATH(appName: String): List[String] = {
     import java.io.File.pathSeparator, java.io.File.pathSeparatorChar
 
-    var path = System.getenv("PATH")
-    val pwd  = os.pwd.toString
+    var path: String = EnvsUtil.EnvVar.Misc.path.valueOpt.getOrElse("")
+    val pwd: String  = os.pwd.toString
 
     // on unix & macs, an empty PATH counts as ".", the working directory
     if (path.length == 0)
@@ -113,7 +114,7 @@ object ProcUtil {
     "/bin/fish"
   )
 
-  def isShebangCapableShell = Option(System.getenv("SHELL")) match
+  def isShebangCapableShell = EnvsUtil.EnvVar.Misc.shell.valueOpt match
     case Some(currentShell) if shebangCapableShells.exists(sh => currentShell.contains(sh)) => true
     case _                                                                                  => false
 }
diff --git a/modules/cli/src/main/scala/scala/cli/packaging/NativeImage.scala b/modules/cli/src/main/scala/scala/cli/packaging/NativeImage.scala
@@ -4,6 +4,7 @@ import java.io.File
 
 import scala.annotation.tailrec
 import scala.build.internal.{ManifestJar, Runner}
+import scala.build.internals.EnvsUtil
 import scala.build.{Build, Logger, Positioned}
 import scala.cli.errors.GraalVMNativeImageError
 import scala.cli.graal.{BytecodeProcessor, TempCache}
@@ -37,19 +38,20 @@ object NativeImage {
 
   private def vcVersions = Seq("2022", "2019", "2017")
   private def vcEditions = Seq("Enterprise", "Community", "BuildTools")
-  lazy val vcvarsCandidates = Option(System.getenv("VCVARSALL")) ++ {
-    for {
-      isX86   <- Seq(false, true)
-      version <- vcVersions
-      edition <- vcEditions
-    } yield {
-      val programFiles = if (isX86) "Program Files (x86)" else "Program Files"
-      """C:\""" + programFiles + """\Microsoft Visual Studio\""" + version + "\\" + edition + """\VC\Auxiliary\Build\vcvars64.bat"""
+  private lazy val vcVarsCandidates: Iterable[String] =
+    EnvsUtil.EnvVar.Misc.vcVarsAll.valueOpt ++ {
+      for {
+        isX86   <- Seq(false, true)
+        version <- vcVersions
+        edition <- vcEditions
+      } yield {
+        val programFiles = if (isX86) "Program Files (x86)" else "Program Files"
+        """C:\""" + programFiles + """\Microsoft Visual Studio\""" + version + "\\" + edition + """\VC\Auxiliary\Build\vcvars64.bat"""
+      }
     }
-  }
 
   private def vcvarsOpt: Option[os.Path] =
-    vcvarsCandidates
+    vcVarsCandidates
       .iterator
       .map(os.Path(_, os.pwd))
       .filter(os.exists(_))
diff --git a/modules/core/src/main/scala/scala/build/internals/EnvsUtil.scala b/modules/core/src/main/scala/scala/build/internals/EnvsUtil.scala
diff --git a/modules/options/src/main/scala/scala/build/interactive/Interactive.scala b/modules/options/src/main/scala/scala/build/interactive/Interactive.scala
diff --git a/modules/options/src/main/scala/scala/build/options/BuildOptions.scala b/modules/options/src/main/scala/scala/build/options/BuildOptions.scala
