Accept --power from anywhere (#2399)

* Accept --power from whole command invocation

* Dont consume --power from ScalaCli.scala, instead add --power to GlobalOptions

* Add --power flag to SharedOptions

---------

Co-authored-by: Piotr Chabelski <[email protected]>

Author: MaciejG604

modules/cli/src/main/scala/scala/cli/ScalaCli.scala

@@ -13,7 +13,7 @@ import scala.build.internal.Constants
 import scala.cli.config.{ConfigDb, Keys}
 import scala.cli.internal.Argv0
 import scala.cli.javaLauncher.JavaLauncherCli
-import scala.cli.launcher.{LauncherCli, LauncherOptions}
+import scala.cli.launcher.{LauncherCli, LauncherOptions, PowerOptions}
 import scala.cli.publish.BouncycastleSignerMaker
 import scala.cli.util.ConfigDbUtils
 import scala.util.Properties
@@ -221,7 +221,7 @@ object ScalaCli {
         launcherOpts.cliVersion.map(_.trim).filter(_.nonEmpty) match {
           case Some(ver) =>
             val powerArgs =
-              if (launcherOpts.power) Seq("--power")
+              if (launcherOpts.powerOptions.power) Seq("--power")
               else Nil
             val newArgs = powerArgs ++ args0
             LauncherCli.runAndExit(ver, launcherOpts, newArgs)
@@ -230,9 +230,21 @@ object ScalaCli {
                 && sys.props.get("scala-cli.kind").exists(_.startsWith("jvm")) =>
             JavaLauncherCli.runAndExit(args)
           case None =>
-            if (launcherOpts.power)
+            if launcherOpts.powerOptions.power then
               isSipScala = false
-            args0.toArray
+              args0.toArray
+            else
+              // Parse again to register --power at any position
+              // Don't consume it, GlobalOptions parsing will do it
+              PowerOptions.parser.ignoreUnrecognized.parse(args0) match {
+                case Right((powerOptions, _)) =>
+                  if powerOptions.power then
+                    isSipScala = false
+                  args0.toArray
+                case Left(e) =>
+                  System.err.println(e.message)
+                  sys.exit(1)
+              }
         }
     }
     val (systemProps, scalaCliArgs) = partitionArgs(remainingArgs)

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

@@ -41,6 +41,7 @@ abstract class ScalaCommand[T <: HasGlobalOptions](implicit myParser: Parser[T],
   override def hasFullHelp = true
   override def hidden      = shouldExcludeInSip
   protected var argvOpt    = Option.empty[Array[String]]
+
   private val shouldExcludeInSip =
     (isRestricted || isExperimental) && !ScalaCli.allowRestrictedFeatures
   override def setArgv(argv: Array[String]): Unit = {

modules/cli/src/main/scala/scala/cli/commands/shared/GlobalOptions.scala

@@ -2,11 +2,19 @@ package scala.cli.commands.shared
 
 import caseapp.*
 
+import scala.cli.launcher.PowerOptions
+
 case class GlobalOptions(
   @Recurse
   logging: LoggingOptions = LoggingOptions(),
   @Recurse
-  globalSuppress: GlobalSuppressWarningOptions = GlobalSuppressWarningOptions()
+  globalSuppress: GlobalSuppressWarningOptions = GlobalSuppressWarningOptions(),
+
+  /** Duplication of [[scala.cli.launcher.LauncherOptions.powerOptions]]. Thanks to this, our unit
+    * tests ensure that no subcommand defines an option that will clash with --power.
+    */
+  @Recurse
+  powerOptions: PowerOptions = PowerOptions()
 )
 
 object GlobalOptions {

modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala

@@ -45,6 +45,7 @@ import scala.cli.commands.util.JvmUtils
 import scala.cli.commands.util.ScalacOptionsUtil.*
 import scala.cli.config.Key.BooleanEntry
 import scala.cli.config.{ConfigDb, Keys}
+import scala.cli.launcher.PowerOptions
 import scala.cli.util.ConfigDbUtils
 import scala.concurrent.ExecutionContextExecutorService
 import scala.concurrent.duration.*
@@ -61,6 +62,8 @@ final case class SharedOptions(
     suppress: SuppressWarningOptions = SuppressWarningOptions(),
   @Recurse
     logging: LoggingOptions = LoggingOptions(),
+  @Recurse
+    powerOptions: PowerOptions = PowerOptions(),
   @Recurse
     js: ScalaJsOptions = ScalaJsOptions(),
   @Recurse
@@ -223,7 +226,7 @@ final case class SharedOptions(
 
   def logger: Logger = logging.logger
   override def global: GlobalOptions =
-    GlobalOptions(logging = logging, globalSuppress = suppress.global)
+    GlobalOptions(logging = logging, globalSuppress = suppress.global, powerOptions = powerOptions)
 
   private def scalaJsOptions(opts: ScalaJsOptions): options.ScalaJsOptions = {
     import opts._

modules/cli/src/main/scala/scala/cli/launcher/LauncherOptions.scala

@@ -19,10 +19,8 @@ final case class LauncherOptions(
   @Hidden
   @Tag(tags.implementation)
   cliScalaVersion: Option[String] = None,
-  @Group(HelpGroup.Launcher.toString)
-  @HelpMessage("When called as 'scala', allow to use power commands too")
-  @Tag(tags.must)
-  power: Boolean = false
+  @Recurse
+  powerOptions: PowerOptions = PowerOptions()
 )
 
 object LauncherOptions {

modules/cli/src/main/scala/scala/cli/launcher/PowerOptions.scala

@@ -0,0 +1,25 @@
+package scala.cli.launcher
+
+import caseapp.*
+
+import scala.cli.commands.shared.HelpGroup
+import scala.cli.commands.tags
+
+/** Options extracted from [[LauncherOptions]] to allow for parsing them separately. Thanks to this
+  * and additional parsing we can read the --power flag placed anywhere in the command invocation.
+  *
+  * This option is duplicated in [[scala.cli.commands.shared.GlobalOptions]] so that we can ensure
+  * that no subcommand defines its own --power option Checking for clashing names is done in unit
+  * tests.
+  */
+case class PowerOptions(
+  @Group(HelpGroup.Launcher.toString)
+  @HelpMessage("Allows to use restricted & experimental features")
+  @Tag(tags.must)
+  power: Boolean = false
+)
+
+object PowerOptions {
+  implicit val parser: Parser[PowerOptions] = Parser.derive
+  implicit val help: Help[PowerOptions]     = Help.derive
+}

modules/cli/src/test/scala/cli/tests/OptionsCheck.scala

@@ -1,6 +1,7 @@
 package scala.cli.tests
 
 import scala.cli.ScalaCliCommands
+import scala.cli.commands.shared.HasGlobalOptions
 
 class OptionsCheck extends munit.FunSuite {
 
@@ -12,4 +13,10 @@ class OptionsCheck extends munit.FunSuite {
       command.ensureNoDuplicates()
     }
 
+    test(s"--power option present in $command") {
+      command.parser.stopAtFirstUnrecognized.parse(Seq("--power")) match {
+        case Right((_: HasGlobalOptions, _ +: _)) => fail("Expected --power to be recognized")
+        case _                                    => ()
+      }
+    }
 }

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

@@ -16,29 +16,30 @@ class ConfigTests extends ScalaCliSuite {
     val name       = "Alex"
     TestInputs.empty.fromRoot { root =>
       val before =
-        os.proc(TestUtil.cli, "--power", "config", "publish.user.name").call(
+        // Test --power placed after subcommand name
+        os.proc(TestUtil.cli, "config", "publish.user.name", "--power").call(
           cwd = root,
           env = configEnv
         )
       expect(before.out.trim().isEmpty)
 
-      os.proc(TestUtil.cli, "--power", "config", "publish.user.name", name).call(
+      os.proc(TestUtil.cli, "config", "publish.user.name", name, "--power").call(
         cwd = root,
         env = configEnv
       )
       val res =
-        os.proc(TestUtil.cli, "--power", "config", "publish.user.name").call(
+        os.proc(TestUtil.cli, "config", "publish.user.name", "--power").call(
           cwd = root,
           env = configEnv
         )
       expect(res.out.trim() == name)
 
-      os.proc(TestUtil.cli, "--power", "config", "publish.user.name", "--unset").call(
+      os.proc(TestUtil.cli, "config", "publish.user.name", "--unset", "--power").call(
         cwd = root,
         env = configEnv
       )
       val after =
-        os.proc(TestUtil.cli, "--power", "config", "publish.user.name").call(
+        os.proc(TestUtil.cli, "config", "publish.user.name", "--power").call(
           cwd = root,
           env = configEnv
         )

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

@@ -38,7 +38,8 @@ abstract class ExportJsonTestDefinitions(val scalaVersionOpt: Option[String])
       TestUtil.initializeGit(root, "v1.1.2")
 
       val exportJsonProc =
-        os.proc(TestUtil.cli, "--power", "export", "--json", ".", "--jvm", "adopt:11")
+        // Test --power placed after subcommand name
+        os.proc(TestUtil.cli, "export", "--power", "--json", ".", "--jvm", "adopt:11")
           .call(cwd = root)
 
       val jsonContents = readJson(exportJsonProc.out.text())

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

@@ -112,12 +112,12 @@ abstract class PublishLocalTestDefinitions(val scalaVersionOpt: Option[String])
       def publishLocal(): os.CommandResult =
         os.proc(
           TestUtil.cli,
-          "--power",
           "publish",
           "local",
           ".",
           "--ivy2-home",
           os.rel / "ivy2",
+          "--power", // Test --power placed after subcommand name
           "--working-dir",
           os.rel / "work-dir",
           extraOptions