Include legacy scala runner options in the help

Author: Gedochao

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

@@ -4,7 +4,7 @@ import caseapp.core.Error
 import caseapp.core.help.{Help, HelpCompanion, RuntimeCommandsHelp}
 import caseapp.core.parser.Parser
 
-import scala.cli.commands.default.DefaultOptions
+import scala.cli.commands.default.{DefaultOptions, LegacyScalaOptions}
 import scala.cli.commands.shared.{HasLoggingOptions, ScalaCliHelp}
 import scala.cli.commands.util.HelpUtils.*
 import scala.cli.launcher.LauncherOptions
@@ -18,12 +18,23 @@ abstract class ScalaCommandWithCustomHelp[T <: HasLoggingOptions](
 ) extends ScalaCommand[T] {
   private def launcherHelp: Help[LauncherOptions] = HelpCompanion.deriveHelp[LauncherOptions]
 
+  private def legacyScalaHelp: Help[LegacyScalaOptions] =
+    HelpCompanion.deriveHelp[LegacyScalaOptions]
+
   protected def customHelp(showHidden: Boolean): String = {
-    val helpString         = actualHelp.help(helpFormat, showHidden)
-    val launcherHelpString = launcherHelp.optionsHelp(helpFormat, showHidden)
+    val helpString            = actualHelp.help(helpFormat, showHidden)
+    val launcherHelpString    = launcherHelp.optionsHelp(helpFormat, showHidden)
+    val legacyScalaHelpString = legacyScalaHelp.optionsHelp(helpFormat, showHidden)
+    val legacyScalaHelpStringWithPadding =
+      if legacyScalaHelpString.nonEmpty then
+        s"""
+           |$legacyScalaHelpString
+           |""".stripMargin
+      else ""
     s"""$helpString
        |
-       |$launcherHelpString""".stripMargin
+       |$launcherHelpString
+       |$legacyScalaHelpStringWithPadding""".stripMargin
   }
 
   protected def customHelpAsked(showHidden: Boolean): Nothing = {

modules/cli/src/main/scala/scala/cli/commands/default/Default.scala

@@ -22,7 +22,6 @@ class Default(
 
   private lazy val defaultCommandHelp: String =
     s"""
-       |
        |When no subcommand is passed explicitly, an implicit subcommand is used based on context:
        |  - if the '--version' option is passed, it prints the 'version' subcommand output, unmodified by any other options
        |  - if any inputs were passed, it defaults to the 'run' subcommand

modules/cli/src/main/scala/scala/cli/commands/default/LegacyScalaOptions.scala

@@ -14,30 +14,35 @@ import scala.cli.commands.tags
   */
 // format: off
 case class LegacyScalaOptions(
-  @Group("Scala")
+  @Group("Legacy Scala runner")
   @HelpMessage(s"Ignored legacy option. Deprecated equivalent of running a subsequent `$PowerString${Package.name}` command.")
   @Tag(tags.must)
+  @Hidden
   @Name("-save")
     save: Option[Indexed[Boolean]] = None,
-  @Group("Scala")
+  @Group("Legacy Scala runner")
   @HelpMessage("Ignored legacy option. Deprecated override canceling the `-nosave` option.")
   @Tag(tags.must)
+  @Hidden
   @Name("-nosave")
     nosave: Option[Indexed[Boolean]] = None,
-  @Group("Scala")
+  @Group("Legacy Scala runner")
   @HelpMessage("Ignored legacy option. Deprecated override defining how the runner should treat the input. Use the appropriate sub-command instead.")
   @Tag(tags.must)
+  @Hidden
   @ValueDescription("object|script|jar|repl|guess")
   @Name("-howtorun")
     howToRun: Option[Indexed[String]] = None,
-  @Group("Scala")
+  @Group("Legacy Scala runner")
   @HelpMessage("Ignored legacy option. Deprecated option allowing to preload inputs for the repl or command execution.")
   @Tag(tags.must)
+  @Hidden
   @ValueDescription("file")
     I: Option[Indexed[List[String]]] = None,
-  @Group("Scala")
+  @Group("Legacy Scala runner")
   @HelpMessage("Ignored legacy option. Deprecated option allowing to prevent the use of the legacy fsc compilation daemon.")
   @Tag(tags.must)
+  @Hidden
   @Name("-nc")
   @Name("-nocompdaemon")
     noCompilationDaemon: Option[Indexed[Boolean]] = None,

modules/integration/src/test/scala/scala/cli/integration/HelpTests.scala

@@ -25,11 +25,46 @@ class HelpTests extends ScalaCliSuite {
     test(s"$helpOptionsString output includes launcher options") {
       expect(helpOutput.contains("--power"))
     }
+
+    test(s"$helpOptionsString output does not include legacy scala runner options") {
+      expect(!helpOutput.contains("Legacy Scala runner options"))
+    }
   }
 
+  for (fullHelpOptions <- HelpTests.fullHelpVariants) {
+    lazy val fullHelp         = os.proc(TestUtil.cli, fullHelpOptions).call(check = false)
+    lazy val fullHelpOutput   = fullHelp.out.trim()
+    val fullHelpOptionsString = fullHelpOptions.mkString(" ")
+    test(s"$fullHelpOptionsString works correctly") {
+      assert(
+        fullHelp.exitCode == 0,
+        clues(fullHelpOptions, fullHelp.out.text(), fullHelp.err.text(), fullHelp.exitCode)
+      )
+      expect(fullHelpOutput.contains("Usage:"))
+    }
+    test(s"$fullHelpOptionsString output includes legacy scala runner options") {
+      expect(fullHelpOutput.contains("Legacy Scala runner options"))
+    }
+  }
 }
 
 object HelpTests {
   val variants =
-    Seq(Seq("help"), Seq("help", "-help"), Seq("help", "--help"), Seq("-help"), Seq("--help"))
+    Seq(
+      Seq("help"),
+      Seq("help", "-help"),
+      Seq("help", "--help"),
+      Seq("-help"),
+      Seq("--help")
+    )
+  val fullHelpVariants =
+    Seq(
+      Seq("help", "--full-help"),
+      Seq("help", "-full-help"),
+      Seq("help", "--help-full"),
+      Seq("help", "-help-full"),
+      Seq("--full-help"),
+      Seq("-full-help"),
+      Seq("-help-full")
+    )
 }