Add default values to help messages

wleczny · wleczny · commit adf2977f2fe0 · 2022-11-09T12:43:18.000+01:00
diff --git a/build.sc b/build.sc
@@ -650,6 +650,31 @@ trait CliOptions extends SbtModule with ScalaCliPublishModule {
   private def scalaVer = Scala.scala213
   def scalaVersion     = scalaVer
   def repositories     = super.repositories ++ customRepositories
+
+  def constantsFile = T.persistent {
+    val dir  = T.dest / "constants"
+    val dest = dir / "Constants.scala"
+    val code =
+      s"""package scala.cli.commands
+         |
+         |/** Build-time constants. Generated by mill. */
+         |object Constants {
+         |  def defaultScalaVersion = "${Scala.defaultUser}"
+         |  def scalaJsVersion = "${Scala.scalaJs}"
+         |  def scalaJsCliVersion = "${InternalDeps.Versions.scalaJsCli}"
+         |  def scalaNativeVersion = "${Deps.nativeTools.dep.version}"
+         |  def ammoniteVersion = "${Deps.ammonite.dep.version}"
+         |  def defaultScalafmtVersion = "${Deps.scalafmtCli.dep.version}"
+         |  def defaultGraalVMJavaVersion = "${deps.graalVmJavaVersion}"
+         |  def defaultGraalVMVersion = "${deps.graalVmVersion}"
+         |  def scalaPyVersion = "${Deps.scalaPy.dep.version}"
+         |}
+         |""".stripMargin
+    if (!os.isFile(dest) || os.read(dest) != code)
+      os.write.over(dest, code, createFolders = true)
+    PathRef(dir)
+  }
+  def generatedSources = super.generatedSources() ++ Seq(constantsFile())
 }
 
 trait Cli extends SbtModule with ProtoBuildModule with CliLaunchers
@@ -866,6 +891,12 @@ trait CliIntegration extends SbtModule with ScalaCliPublishModule with HasTests
            |  def scala3   = "${Scala.scala3}"
            |  def defaultScala = "${Scala.defaultUser}"
            |  def defaultScalafmtVersion = "${Deps.scalafmtCli.dep.version}"
+           |  def scalaJsVersion = "${Scala.scalaJs}"
+           |  def scalaNativeVersion = "${Deps.nativeTools.dep.version}"
+           |  def ammoniteVersion = "${Deps.ammonite.dep.version}"
+           |  def defaultGraalVMJavaVersion = "${deps.graalVmJavaVersion}"
+           |  def defaultGraalVMVersion = "${deps.graalVmVersion}"
+           |  def scalaPyVersion = "${Deps.scalaPy.dep.version}"
            |  def bloopVersion = "${Deps.bloopConfig.dep.version}"
            |  def pprintVersion = "${TestDeps.pprint.dep.version}"
            |  def munitVersion = "${TestDeps.munit.dep.version}"
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/FmtOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/FmtOptions.scala
@@ -2,6 +2,7 @@ package scala.cli.commands
 
 import caseapp.*
 
+import scala.cli.commands.Constants
 import scala.cli.commands.common.HasSharedOptions
 
 // format: off
@@ -57,7 +58,7 @@ final case class FmtOptions(
   @Name("dialect")
     scalafmtDialect: Option[String] = None,
   @Group("Format")
-  @HelpMessage("Pass scalafmt version before running it. This overrides whatever value is configured in the .scalafmt.conf file.")
+  @HelpMessage(s"Pass scalafmt version before running it (${Constants.defaultScalafmtVersion} by default). If passed, this overrides whatever value is configured in the .scalafmt.conf file.")
   @Name("fmtVersion")
     scalafmtVersion: Option[String] = None
 ) extends HasSharedOptions
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/PackagerOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/PackagerOptions.scala
@@ -2,6 +2,8 @@ package scala.cli.commands
 
 import caseapp.{Group, Help, HelpMessage, Name, Parser, ValueDescription}
 
+import scala.cli.commands.Constants
+
 // format: off
 final case class PackagerOptions(
   @HelpMessage("Set the version of the generated package")
@@ -107,11 +109,11 @@ final case class PackagerOptions(
   dockerImageTag: Option[String] = None,
 
   @Group("Native image")
-  @HelpMessage("GraalVM Java major version to use to build GraalVM native images (like 17)")
+  @HelpMessage(s"GraalVM Java major version to use to build GraalVM native images (${Constants.defaultGraalVMJavaVersion} by default)")
   @ValueDescription("java-major-version")
     graalvmJavaVersion: Option[Int] = None,
   @Group("Native image")
-  @HelpMessage("GraalVM version to use to build GraalVM native images (like 22.0.0)")
+  @HelpMessage(s"GraalVM version to use to build GraalVM native images (${Constants.defaultGraalVMVersion} by default)")
   @ValueDescription("version")
     graalvmVersion: Option[String] = None,
   @Group("Native image")
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/ScalaJsOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/ScalaJsOptions.scala
@@ -4,6 +4,8 @@ import caseapp.*
 import com.github.plokhotnyuk.jsoniter_scala.core.*
 import com.github.plokhotnyuk.jsoniter_scala.macros.*
 
+import scala.cli.commands.Constants
+
 // format: off
 final case class ScalaJsOptions(
 
@@ -12,7 +14,7 @@ final case class ScalaJsOptions(
     js: Boolean = false,
 
   @Group("Scala.js")
-  @HelpMessage("The Scala.js version")
+  @HelpMessage(s"The Scala.js version (${Constants.scalaJsVersion} by default).")
     jsVersion: Option[String] = None,
   @Group("Scala.js")
   @HelpMessage("The Scala.js mode, either `dev` or `release`")
@@ -61,7 +63,7 @@ final case class ScalaJsOptions(
   @Hidden
     jsLinkerPath: Option[String] = None,
   @Group("Scala.js")
-  @HelpMessage("Scala.js CLI version to use for linking")
+  @HelpMessage(s"Scala.js CLI version to use for linking (${Constants.scalaJsCliVersion} by default).")
   @ValueDescription("version")
   @Hidden
     jsCliVersion: Option[String] = None,
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/ScalaNativeOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/ScalaNativeOptions.scala
@@ -4,6 +4,8 @@ import caseapp.*
 import com.github.plokhotnyuk.jsoniter_scala.core.*
 import com.github.plokhotnyuk.jsoniter_scala.macros.*
 
+import scala.cli.commands.Constants
+
 // format: off
 final case class ScalaNativeOptions(
 
@@ -12,7 +14,7 @@ final case class ScalaNativeOptions(
     native: Boolean = false,
 
   @Group("Scala Native")
-  @HelpMessage("Set the Scala Native version")
+  @HelpMessage(s"Set the Scala Native version (${Constants.scalaNativeVersion} by default).")
     nativeVersion: Option[String] = None,
   @Group("Scala Native")
   @HelpMessage("Set Scala Native compilation mode")
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/SharedOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/SharedOptions.scala
@@ -5,6 +5,7 @@ import caseapp.core.help.Help
 import com.github.plokhotnyuk.jsoniter_scala.core.*
 import com.github.plokhotnyuk.jsoniter_scala.macros.*
 
+import scala.cli.commands.Constants
 import scala.cli.commands.common.HasLoggingOptions
 
 // format: off
@@ -31,7 +32,7 @@ final case class SharedOptions(
     workspace: SharedWorkspaceOptions = SharedWorkspaceOptions(),
 
   @Group("Scala")
-  @HelpMessage("Set the Scala version")
+  @HelpMessage(s"Set the Scala version (${Constants.defaultScalaVersion} by default)")
   @ValueDescription("version")
   @Name("scala")
   @Name("S")
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/SharedPythonOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/SharedPythonOptions.scala
@@ -2,14 +2,16 @@ package scala.cli.commands
 
 import caseapp.*
 
+import scala.cli.commands.Constants
+
 // format: off
 final case class SharedPythonOptions(
   @HelpMessage("[experimental] Set Java options so that Python can be loaded")
     pythonSetup: Option[Boolean] = None,
   @HelpMessage("[experimental] Enable Python support via ScalaPy")
   @ExtraName("py")
     python: Option[Boolean] = None,
-  @HelpMessage("[experimental] Set ScalaPy version")
+  @HelpMessage(s"[experimental] Set ScalaPy version (${Constants.scalaPyVersion} by default)")
   @ExtraName("scalapyVersion")
     scalaPyVersion: Option[String] = None
 )
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/SharedReplOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/SharedReplOptions.scala
@@ -3,6 +3,8 @@ package scala.cli.commands
 import caseapp.*
 import caseapp.core.help.Help
 
+import scala.cli.commands.Constants
+
 // format: off
 final case class SharedReplOptions(
   @Recurse
@@ -21,7 +23,7 @@ final case class SharedReplOptions(
     ammonite: Option[Boolean] = None,
 
   @Group("Repl")
-  @HelpMessage("[restricted] Set the Ammonite version")
+  @HelpMessage(s"[restricted] Set the Ammonite version (${Constants.ammoniteVersion} by default)")
   @Name("ammoniteVer")
     ammoniteVersion: Option[String] = None,
 
diff --git a/modules/integration/src/test/scala/scala/cli/integration/FmtTests.scala b/modules/integration/src/test/scala/scala/cli/integration/FmtTests.scala
@@ -2,6 +2,8 @@ package scala.cli.integration
 
 import com.eed3si9n.expecty.Expecty.expect
 
+import scala.cli.integration.TestUtil.removeAnsiColors
+
 class FmtTests extends ScalaCliSuite {
 
   override def group: ScalaCliSuite.TestGroup = ScalaCliSuite.TestGroup.First
@@ -207,4 +209,13 @@ class FmtTests extends ScalaCliSuite {
       expect(updatedContent == expectedSimpleInputsFormattedContent)
     }
   }
+
+  test("default values in help") {
+    TestInputs.empty.fromRoot { root =>
+      val res            = os.proc(TestUtil.cli, "fmt", "--help").call(cwd = root)
+      val lines          = removeAnsiColors(res.out.trim()).linesIterator.toVector
+      val fmtVersionHelp = lines.find(_.contains("--fmt-version")).getOrElse("")
+      expect(fmtVersionHelp.contains(s"(${Constants.defaultScalafmtVersion} by default)"))
+    }
+  }
 }
diff --git a/modules/integration/src/test/scala/scala/cli/integration/PackageTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/PackageTestDefinitions.scala
@@ -9,6 +9,7 @@ import java.util
 import java.util.regex.Pattern
 import java.util.zip.ZipFile
 
+import scala.cli.integration.TestUtil.removeAnsiColors
 import scala.jdk.CollectionConverters.*
 import scala.util.{Properties, Using}
 
@@ -878,4 +879,19 @@ abstract class PackageTestDefinitions(val scalaVersionOpt: Option[String])
     test("pass java options to docker") {
       javaOptionsDockerTest()
     }
+
+  test("default values in help") {
+    TestInputs.empty.fromRoot { root =>
+      val res   = os.proc(TestUtil.cli, "package", extraOptions, "--help").call(cwd = root)
+      val lines = removeAnsiColors(res.out.trim()).linesIterator.toVector
+
+      val graalVmVersionHelp     = lines.find(_.contains("--graalvm-version")).getOrElse("")
+      val graalVmJavaVersionHelp = lines.find(_.contains("--graalvm-java-version")).getOrElse("")
+
+      expect(graalVmVersionHelp.contains(s"(${Constants.defaultGraalVMVersion} by default)"))
+      expect(
+        graalVmJavaVersionHelp.contains(s"(${Constants.defaultGraalVMJavaVersion} by default)")
+      )
+    }
+  }
 }
diff --git a/modules/integration/src/test/scala/scala/cli/integration/ReplTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/ReplTestDefinitions.scala
@@ -2,6 +2,7 @@ package scala.cli.integration
 
 import com.eed3si9n.expecty.Expecty.expect
 
+import scala.cli.integration.TestUtil.removeAnsiColors
 import scala.util.Properties
 
 abstract class ReplTestDefinitions(val scalaVersionOpt: Option[String])
@@ -75,4 +76,18 @@ abstract class ReplTestDefinitions(val scalaVersionOpt: Option[String])
     }
   }
 
+  test("default values in help") {
+    TestInputs.empty.fromRoot { root =>
+      val res   = os.proc(TestUtil.cli, "repl", extraOptions, "--help").call(cwd = root)
+      val lines = removeAnsiColors(res.out.trim()).linesIterator.toVector
+
+      val scalaVersionHelp   = lines.find(_.contains("--scala-version")).getOrElse("")
+      val scalaPyVersionHelp = lines.find(_.contains("--scalapy-version")).getOrElse("")
+      val ammVersionHelp     = lines.find(_.contains("--ammonite-ver")).getOrElse("")
+
+      expect(scalaVersionHelp.contains(s"(${Constants.defaultScala} by default)"))
+      expect(scalaPyVersionHelp.contains(s"(${Constants.scalaPyVersion} by default)"))
+      expect(ammVersionHelp.contains(s"(${Constants.ammoniteVersion} by default)"))
+    }
+  }
 }
diff --git a/modules/integration/src/test/scala/scala/cli/integration/RunScalaJsTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/RunScalaJsTestDefinitions.scala
@@ -2,6 +2,8 @@ package scala.cli.integration
 
 import com.eed3si9n.expecty.Expecty.expect
 
+import scala.cli.integration.TestUtil.removeAnsiColors
+
 trait RunScalaJsTestDefinitions { _: RunTestDefinitions =>
   def simpleJsTest(extraArgs: String*): Unit = {
     val fileName = "simple.sc"
@@ -170,10 +172,13 @@ trait RunScalaJsTestDefinitions { _: RunTestDefinitions =>
     }
 
   test("help js") {
-    val helpJsOption = "--help-js"
-    val helpJs       = os.proc(TestUtil.cli, "run", helpJsOption).call(check = false)
-    expect(helpJs.out.text().contains("Scala.js options"))
-    expect(!helpJs.out.text().contains("Scala Native options"))
+    val helpJsOption  = "--help-js"
+    val helpJs        = os.proc(TestUtil.cli, "run", helpJsOption).call(check = false)
+    val lines         = removeAnsiColors(helpJs.out.trim()).linesIterator.toVector
+    val jsVersionHelp = lines.find(_.contains("--js-version")).getOrElse("")
+    expect(jsVersionHelp.contains(s"(${Constants.scalaJsVersion} by default)"))
+    expect(lines.exists(_.contains("Scala.js options")))
+    expect(!lines.exists(_.contains("Scala Native options")))
   }
 
   test("Directory JS") {
diff --git a/modules/integration/src/test/scala/scala/cli/integration/RunScalaNativeTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/RunScalaNativeTestDefinitions.scala
@@ -2,6 +2,8 @@ package scala.cli.integration
 
 import com.eed3si9n.expecty.Expecty.expect
 
+import scala.cli.integration.TestUtil.removeAnsiColors
+
 trait RunScalaNativeTestDefinitions { _: RunTestDefinitions =>
   def simpleNativeTests(): Unit = {
     val fileName = "simple.sc"
@@ -224,9 +226,12 @@ trait RunScalaNativeTestDefinitions { _: RunTestDefinitions =>
     }
 
   test("help native") {
-    val helpNativeOption = "--help-native"
-    val helpNative       = os.proc(TestUtil.cli, "run", helpNativeOption).call(check = false)
-    expect(helpNative.out.text().contains("Scala Native options"))
-    expect(!helpNative.out.text().contains("Scala.js options"))
+    val helpNativeOption  = "--help-native"
+    val helpNative        = os.proc(TestUtil.cli, "run", helpNativeOption).call(check = false)
+    val lines             = removeAnsiColors(helpNative.out.trim()).linesIterator.toVector
+    val nativeVersionHelp = lines.find(_.contains("--native-version")).getOrElse("")
+    expect(nativeVersionHelp.contains(s"(${Constants.scalaNativeVersion} by default)"))
+    expect(lines.exists(_.contains("Scala Native options")))
+    expect(!lines.exists(_.contains("Scala.js options")))
   }
 }
diff --git a/modules/integration/src/test/scala/scala/cli/integration/TestUtil.scala b/modules/integration/src/test/scala/scala/cli/integration/TestUtil.scala
@@ -96,6 +96,8 @@ object TestUtil {
     if (uri.startsWith("file:///")) "file:/" + uri.stripPrefix("file:///")
     else uri
 
+  def removeAnsiColors(str: String) = str.replaceAll("\\e\\[[0-9]+m", "")
+
   def retry[T](
     maxAttempts: Int = 3,
     waitDuration: FiniteDuration = 5.seconds
diff --git a/website/docs/reference/cli-options.md b/website/docs/reference/cli-options.md
@@ -316,7 +316,7 @@ Pass a global dialect for scalafmt. This overrides whatever value is configured
 
 Aliases: `--fmt-version`
 
-Pass scalafmt version before running it. This overrides whatever value is configured in the .scalafmt.conf file.
+Pass scalafmt version before running it (3.5.9 by default). If passed, this overrides whatever value is configured in the .scalafmt.conf file.
 
 ## Help options
 
@@ -747,11 +747,11 @@ The image tag; the default tag is `latest`
 
 ### `--graalvm-java-version`
 
-GraalVM Java major version to use to build GraalVM native images (like 17)
+GraalVM Java major version to use to build GraalVM native images (17 by default)
 
 ### `--graalvm-version`
 
-GraalVM version to use to build GraalVM native images (like 22.0.0)
+GraalVM version to use to build GraalVM native images (22.2.0 by default)
 
 ### `--graalvm-jvm-id`
 
@@ -984,7 +984,7 @@ Aliases: `--py`
 
 Aliases: `--scalapy-version`
 
-[experimental] Set ScalaPy version
+[experimental] Set ScalaPy version (0.5.2+5-83f1eb68 by default)
 
 ## Repl options
 
@@ -1004,7 +1004,7 @@ Aliases: `-A`, `--amm`
 
 Aliases: `--ammonite-ver`
 
-[restricted] Set the Ammonite version
+[restricted] Set the Ammonite version (2.5.5 by default)
 
 ### `--ammonite-arg`
 
@@ -1079,7 +1079,7 @@ Enable Scala.js. To show more options for Scala.js pass `--help-js`
 
 ### `--js-version`
 
-The Scala.js version
+The Scala.js version (1.10.1 by default).
 
 ### `--js-mode`
 
@@ -1139,7 +1139,7 @@ Path to the Scala.js linker
 ### `--js-cli-version`
 
 [Internal]
-Scala.js CLI version to use for linking
+Scala.js CLI version to use for linking (1.1.1-sc6 by default).
 
 ### `--js-cli-java-arg`
 
@@ -1165,7 +1165,7 @@ Enable Scala Native. To show more options for Scala Native pass `--help-native`
 
 ### `--native-version`
 
-Set the Scala Native version
+Set the Scala Native version (0.4.7 by default).
 
 ### `--native-mode`
 
@@ -1284,7 +1284,7 @@ Available in commands:
 
 Aliases: `--scala`, `-S`
 
-Set the Scala version
+Set the Scala version (3.2.0 by default)
 
 ### `--scala-binary-version`
 
diff --git a/website/docs/reference/scala-command/cli-options.md b/website/docs/reference/scala-command/cli-options.md

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@ package scala.cli.integration`
`2`	`2`
`3`	`3`	`import com.eed3si9n.expecty.Expecty.expect`
`4`	`4`
	`5`	`+import scala.cli.integration.TestUtil.removeAnsiColors`
	`6`	`+`
`5`	`7`	`class FmtTests extends ScalaCliSuite {`
`6`	`8`
`7`	`9`	`override def group: ScalaCliSuite.TestGroup = ScalaCliSuite.TestGroup.First`
`@@ -207,4 +209,13 @@ class FmtTests extends ScalaCliSuite {`
`207`	`209`	`expect(updatedContent == expectedSimpleInputsFormattedContent)`
`208`	`210`	`}`
`209`	`211`	`}`
	`212`	`+`
	`213`	`+ test("default values in help") {`
	`214`	`+ TestInputs.empty.fromRoot { root =>`
	`215`	`+ val res = os.proc(TestUtil.cli, "fmt", "--help").call(cwd = root)`
	`216`	`+ val lines = removeAnsiColors(res.out.trim()).linesIterator.toVector`
	`217`	`+ val fmtVersionHelp = lines.find(_.contains("--fmt-version")).getOrElse("")`
	`218`	`+ expect(fmtVersionHelp.contains(s"(${Constants.defaultScalafmtVersion} by default)"))`
	`219`	`+ }`
	`220`	`+ }`
`210`	`221`	`}`