Add description to help messages

Author: MarcinAman

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

@@ -3,6 +3,7 @@ package scala.cli.commands
 import caseapp._
 
 // format: off
+@HelpMessage("Start BSP server")
 final case class BspOptions(
   // FIXME There might be too many options in SharedOptions for the bsp command…
   @Recurse

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

@@ -5,6 +5,7 @@ import caseapp._
 // format: off
 final case class CompileCrossOptions(
   @HelpMessage("Cross-compile sources")
+  @Hidden
     cross: Option[Boolean] = None
 )
 // format: on

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

@@ -11,6 +11,7 @@ final case class CoursierOptions(
   @Group("Dependency")
   @HelpMessage("Specify a TTL for changing dependencies, such as snapshots")
   @ValueDescription("duration|Inf")
+  @Hidden
     ttl: Option[String] = None
 ) {
   // format: on

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

@@ -3,6 +3,8 @@ package scala.cli.commands
 import caseapp._
 
 object Directories extends ScalaCommand[DirectoriesOptions] {
+  override def hidden: Boolean = true
+
   def run(options: DirectoriesOptions, args: RemainingArgs): Unit = {
     if (args.all.nonEmpty) {
       System.err.println("The directories command doesn't accept arguments.")

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

@@ -3,6 +3,7 @@ package scala.cli.commands
 import caseapp._
 
 // format: off
+@HelpMessage("Prints directories used by scala-cli")
 final case class DirectoriesOptions(
   @Recurse
     directories: SharedDirectoriesOptions = SharedDirectoriesOptions()

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

@@ -5,20 +5,25 @@ import caseapp._
 import scala.build.options.BuildOptions
 
 // format: off
+@HelpMessage("Export current project to SBT or Mill")
 final case class ExportOptions(
   // FIXME There might be too many options for 'scala-cli export' there
   @Recurse
     shared: SharedOptions = SharedOptions(),
   @Recurse
     mainClass: MainClassOptions = MainClassOptions(),
-
+  
+  @Group("Build Tool export options")
   sbt: Option[Boolean] = None,
+  @Group("Build Tool export options")
   mill: Option[Boolean] = None,
 
   @Name("setting")
+  @Group("Build Tool export options")
     sbtSetting: List[String] = Nil,
 
   @Name("o")
+  @Group("Build Tool export options")
     output: Option[String] = None
 ) {
   // format: on

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

@@ -11,13 +11,14 @@ import scala.cli.internal.{Argv0, ProfileFileUpdater}
 
 object InstallCompletions extends ScalaCommand[InstallCompletionsOptions] {
   override def names = List(
-    List("install", "completions")
+    List("install", "completions"),
+    List("install-completions")
   )
   private lazy val home = os.Path(sys.props("user.home"), os.pwd)
   def run(options: InstallCompletionsOptions, args: RemainingArgs): Unit = {
 
     lazy val completionsDir =
-      options.directory
+      options.output
         .map(os.Path(_, os.pwd))
         .getOrElse(options.directories.directories.completionsDir)
 

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

@@ -3,19 +3,33 @@ package scala.cli.commands
 import caseapp._
 
 // format: off
+@HelpMessage("Installs completions into your shell")
 final case class InstallCompletionsOptions(
   @Recurse
     logging: LoggingOptions = LoggingOptions(),
   @Recurse
     directories: SharedDirectoriesOptions = SharedDirectoriesOptions(),
 
   @Name("shell")
+  @HelpMessage("Name of the shell, either zsh or bash")
     format: Option[String] = None,
 
+  @HelpMessage("Path to *rc file, defaults to .bashrc or .zshrc depending on shell")
   rcFile: Option[String] = None,
-  directory: Option[String] = None,
+
+  @HelpMessage("Completions output directory")
+  @Name("o")
+  output: Option[String] = None,
+
+  @Hidden
+  @HelpMessage("Custom banner in comment placed in rc file")
   banner: String = "{NAME} completions",
+
+  @Hidden
+  @HelpMessage("Custom completions name")
   name: Option[String] = None,
+
+  @HelpMessage("Print completions to stdout")
   env: Boolean = false
 )
 // format: on

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

@@ -13,17 +13,23 @@ final case class ScalaJsOptions(
     js: Boolean = false,
 
   @Group("Scala.JS")
+  @HelpMessage("Scala JS version")
     jsVersion: Option[String] = None,
   @Group("Scala.JS")
+  @HelpMessage("Scala JS mode, either \"dev\" or \"release\"")
     jsMode: Option[String] = None,
+  @HelpMessage("Scala JS module kind: commonjs/common, esmodule/es, nomodule/none")
   @Group("Scala.JS")
     jsModuleKind: Option[String] = None,
 
+  @Group("Scala.JS")
   jsCheckIr: Option[Boolean] = None,
 
   @Group("Scala.JS")
+  @HelpMessage("Emit source maps")
     jsEmitSourceMaps: Boolean = false,
   @Group("Scala.JS")
+  @HelpMessage("Enable jsdom")
     jsDom: Option[Boolean] = None
 
 ) {

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

@@ -13,26 +13,38 @@ final case class ScalaNativeOptions(
     native: Boolean = false,
 
   @Group("Scala Native")
+  @HelpMessage("Scala Native version")
     nativeVersion: Option[String] = None,
   @Group("Scala Native")
+  @HelpMessage("Scala Native compilation mode")
     nativeMode: Option[String] = None,
   @Group("Scala Native")
+  @HelpMessage("Scala Native garbage collector")
     nativeGc: Option[String] = None,
 
   @Group("Scala Native")
+  @HelpMessage("Path to Clang command")
     nativeClang: Option[String] = None,
   @Group("Scala Native")
+  @HelpMessage("Path to Clang++ command")
     nativeClangpp: Option[String] = None,
 
   @Group("Scala Native")
+  @HelpMessage("Extra options passed to clang verbatim during linking")
     nativeLinking: List[String] = Nil,
   @Group("Scala Native")
-    nativeLinkingDefaults: Option[Boolean] = None,
+  @HelpMessage("Use default linking settings")
+  @Hidden
+    nativeLinkingDefaults: Option[Boolean] = None, //TODO does it even work when we default it to true while handling?
 
   @Group("Scala Native")
+  @HelpMessage("List of compile options")
     nativeCompile: List[String] = Nil,
+
   @Group("Scala Native")
-    nativeCompileDefaults: Option[Boolean] = None
+  @Hidden
+  @HelpMessage("Use default compile options")
+    nativeCompileDefaults: Option[Boolean] = None //TODO does it even work when we default it to true while handling?
 
 ) {
   // format: on