Hide some commands when called as 'scala'

alexarchambault · alexarchambault · commit f35ef5870dee · 2022-01-26T19:12:08.000+01:00
diff --git a/modules/cli/src/main/scala/scala/cli/ScalaCli.scala b/modules/cli/src/main/scala/scala/cli/ScalaCli.scala
@@ -2,7 +2,7 @@ package scala.cli
 
 import sun.misc.{Signal, SignalHandler}
 
-import java.io.{ByteArrayOutputStream, PrintStream}
+import java.io.{ByteArrayOutputStream, File, PrintStream}
 import java.nio.charset.StandardCharsets
 
 import scala.build.internal.Constants
@@ -14,6 +14,11 @@ object ScalaCli {
 
   val progName = (new Argv0).get("scala-cli")
 
+  private var isSipScala =
+    progName == "scala" ||
+    progName.endsWith("/scala") ||
+    progName.endsWith(File.separator + "scala")
+
   private def isGraalvmNativeImage: Boolean =
     sys.props.contains("org.graalvm.nativeimage.imagecode")
 
@@ -109,8 +114,15 @@ object ScalaCli {
       case Right((launcherOpts, args0)) =>
         launcherOpts.cliVersion.map(_.trim).filter(_.nonEmpty) match {
           case Some(ver) =>
-            LauncherCli.runAndExit(ver, launcherOpts, args0)
-          case None => args0.toArray
+            val powerArgs =
+              if (launcherOpts.power) Seq("--power")
+              else Nil
+            val newArgs = powerArgs ++ args0
+            LauncherCli.runAndExit(ver, launcherOpts, newArgs)
+          case None =>
+            if (launcherOpts.power)
+              isSipScala = false
+            args0.toArray
         }
     }
     val (systemProps, scalaCliArgs) = partitionArgs(remainingArgs)
@@ -132,7 +144,7 @@ object ScalaCli {
       // Enable ANSI output in Windows terminal
       coursier.jniutils.WindowsAnsiTerminal.enableAnsiOutput()
 
-    new ScalaCliCommands(progName)
+    new ScalaCliCommands(progName, isSipScala)
       .main(scalaCliArgs)
   }
 }
diff --git a/modules/cli/src/main/scala/scala/cli/ScalaCliCommands.scala b/modules/cli/src/main/scala/scala/cli/ScalaCliCommands.scala
@@ -7,12 +7,15 @@ import java.nio.file.InvalidPathException
 
 import scala.cli.commands._
 
-class ScalaCliCommands(val progName: String) extends CommandsEntryPoint {
+class ScalaCliCommands(
+  val progName: String,
+  isSipScala: Boolean
+) extends CommandsEntryPoint {
 
   lazy val actualDefaultCommand: DefaultBase = new Default(help)
 
-  def commands = Seq[ScalaCommand[_]](
-    About,
+  private def allCommands = Seq[ScalaCommand[_]](
+    new About(isSipScala = isSipScala),
     AddPath,
     BloopExit,
     BloopStart,
@@ -36,6 +39,8 @@ class ScalaCliCommands(val progName: String) extends CommandsEntryPoint {
     Version
   )
 
+  def commands = allCommands.filter(c => !isSipScala || c.inSipScala)
+
   override def description =
     "Scala CLI is a command-line tool to interact with the Scala language. It lets you compile, run, test, and package your Scala code."
   override def summaryDesc =
diff --git a/modules/cli/src/main/scala/scala/cli/commands/About.scala b/modules/cli/src/main/scala/scala/cli/commands/About.scala
@@ -5,12 +5,15 @@ import caseapp._
 import scala.build.internal.Constants
 import scala.cli.CurrentParams
 
-object About extends ScalaCommand[AboutOptions] {
+class About(isSipScala: Boolean) extends ScalaCommand[AboutOptions] {
   override def group = "Miscellaneous"
   def run(options: AboutOptions, args: RemainingArgs): Unit = {
     CurrentParams.verbosity = options.verbosity.verbosity
     val version            = Constants.version
     val detailedVersionOpt = Some(Constants.detailedVersion).filter(_ != version)
-    println(s"Scala CLI version $version" + detailedVersionOpt.fold("")(" (" + _ + ")"))
+    val appName =
+      if (isSipScala) "Scala command"
+      else "Scala CLI"
+    println(s"$appName version $version" + detailedVersionOpt.fold("")(" (" + _ + ")"))
   }
 }
diff --git a/modules/cli/src/main/scala/scala/cli/commands/AddPath.scala b/modules/cli/src/main/scala/scala/cli/commands/AddPath.scala
@@ -9,7 +9,8 @@ import scala.cli.CurrentParams
 import scala.util.Properties
 
 object AddPath extends ScalaCommand[AddPathOptions] {
-  override def hidden = true
+  override def hidden     = true
+  override def inSipScala = false
   def run(options: AddPathOptions, args: RemainingArgs): Unit = {
     CurrentParams.verbosity = options.verbosity
 
diff --git a/modules/cli/src/main/scala/scala/cli/commands/BloopExit.scala b/modules/cli/src/main/scala/scala/cli/commands/BloopExit.scala
@@ -7,7 +7,8 @@ import scala.build.blooprifle.BloopRifle
 import scala.cli.CurrentParams
 
 object BloopExit extends ScalaCommand[BloopExitOptions] {
-  override def hidden = true
+  override def hidden     = true
+  override def inSipScala = false
   override def names: List[List[String]] = List(
     List("bloop", "exit")
   )
diff --git a/modules/cli/src/main/scala/scala/cli/commands/BloopStart.scala b/modules/cli/src/main/scala/scala/cli/commands/BloopStart.scala
@@ -11,7 +11,8 @@ import scala.concurrent.Await
 import scala.concurrent.duration.Duration
 
 object BloopStart extends ScalaCommand[BloopStartOptions] {
-  override def hidden = true
+  override def hidden     = true
+  override def inSipScala = false
   override def names: List[List[String]] = List(
     List("bloop", "start")
   )
diff --git a/modules/cli/src/main/scala/scala/cli/commands/Directories.scala b/modules/cli/src/main/scala/scala/cli/commands/Directories.scala
@@ -6,6 +6,7 @@ import scala.cli.CurrentParams
 
 object Directories extends ScalaCommand[DirectoriesOptions] {
   override def hidden: Boolean = true
+  override def inSipScala      = false
 
   def run(options: DirectoriesOptions, args: RemainingArgs): Unit = {
     CurrentParams.verbosity = options.verbosity.verbosity
diff --git a/modules/cli/src/main/scala/scala/cli/commands/InstallHome.scala b/modules/cli/src/main/scala/scala/cli/commands/InstallHome.scala
@@ -9,6 +9,7 @@ import scala.util.Properties
 
 object InstallHome extends ScalaCommand[InstallHomeOptions] {
   override def hidden: Boolean = true
+  override def inSipScala      = false
 
   private def logEqual(version: String) = {
     System.err.println(
diff --git a/modules/cli/src/main/scala/scala/cli/commands/Metabrowse.scala b/modules/cli/src/main/scala/scala/cli/commands/Metabrowse.scala
@@ -11,8 +11,9 @@ import scala.cli.CurrentParams
 import scala.cli.internal.FetchExternalBinary
 
 object Metabrowse extends ScalaCommand[MetabrowseOptions] {
-  override def hidden = true
-  override def group  = "Miscellaneous"
+  override def hidden     = true
+  override def inSipScala = false
+  override def group      = "Miscellaneous"
   override def names = List(
     List("browse"),
     List("metabrowse")
diff --git a/modules/cli/src/main/scala/scala/cli/commands/ScalaCommand.scala b/modules/cli/src/main/scala/scala/cli/commands/ScalaCommand.scala
@@ -17,6 +17,8 @@ abstract class ScalaCommand[T](implicit parser: Parser[T], help: Help[T])
   def sharedOptions(t: T): Option[SharedOptions] = None
   override def hasFullHelp                       = true
 
+  def inSipScala: Boolean = true
+
   protected var argvOpt = Option.empty[Array[String]]
   override def setArgv(argv: Array[String]): Unit = {
     argvOpt = Some(argv)
diff --git a/modules/cli/src/main/scala/scala/cli/launcher/LauncherOptions.scala b/modules/cli/src/main/scala/scala/cli/launcher/LauncherOptions.scala
@@ -10,7 +10,11 @@ final case class LauncherOptions(
   @Group("Launcher")
   @HelpMessage("The version of Scala on which Scala CLI was published")
   @ValueDescription("2.12|2.13|3")
-  cliScalaVersion: Option[String] = None
+  cliScalaVersion: Option[String] = None,
+  @Group("Launcher")
+  @HelpMessage("When called as 'scala', allow to use power commands too")
+  @Hidden
+  power: Boolean = false
 )
 
 object LauncherOptions {
diff --git a/modules/cli/src/test/scala/cli/tests/HelpCheck.scala b/modules/cli/src/test/scala/cli/tests/HelpCheck.scala
@@ -5,7 +5,7 @@ import scala.cli.ScalaCliCommands
 class HelpCheck extends munit.FunSuite {
 
   test("help message should be shorter then 80 lines") {
-    val scalaCli    = new ScalaCliCommands("scala-cli")
+    val scalaCli    = new ScalaCliCommands("scala-cli", isSipScala = false)
     val helpMessage = scalaCli.help.help(scalaCli.helpFormat)
 
     val lines = helpMessage.split("\r\n|\r|\n").length
diff --git a/modules/cli/src/test/scala/cli/tests/OptionsCheck.scala b/modules/cli/src/test/scala/cli/tests/OptionsCheck.scala
@@ -4,7 +4,7 @@ import scala.cli.ScalaCliCommands
 
 class OptionsCheck extends munit.FunSuite {
 
-  for (command <- (new ScalaCliCommands("scala-cli")).commands)
+  for (command <- (new ScalaCliCommands("scala-cli", isSipScala = false)).commands)
     test(s"No duplicated options in ${command.names.head.mkString(" ")}") {
       command.ensureNoDuplicates()
     }
diff --git a/modules/generate-reference-doc/src/main/scala/scala/cli/doc/GenerateReferenceDoc.scala b/modules/generate-reference-doc/src/main/scala/scala/cli/doc/GenerateReferenceDoc.scala
@@ -283,7 +283,7 @@ object GenerateReferenceDoc extends CaseApp[Options] {
 
   def run(options: Options, args: RemainingArgs): Unit = {
 
-    val scalaCli      = new ScalaCliCommands("scala-cli")
+    val scalaCli      = new ScalaCliCommands("scala-cli", isSipScala = false)
     val commands      = scalaCli.commands
     val allArgs       = commands.flatMap(_.finalHelp.args)
     val nameFormatter = scalaCli.actualDefaultCommand.nameFormatter
diff --git a/modules/integration/src/test/scala/scala/cli/integration/SipScalaTests.scala b/modules/integration/src/test/scala/scala/cli/integration/SipScalaTests.scala
@@ -0,0 +1,38 @@
+package scala.cli.integration
+
+import com.eed3si9n.expecty.Expecty.expect
+
+import scala.util.Properties
+
+class SipScalaTests extends munit.FunSuite {
+
+  def noDirectoriesCommandTest(): Unit =
+    TestInputs(Nil).fromRoot { root =>
+      val cliPath = os.Path(TestUtil.cliPath, os.pwd)
+
+      os.proc(cliPath, "directories").call(cwd = root)
+      os.proc(cliPath, "compile", "--help").call(cwd = root)
+      os.proc(cliPath, "run", "--help").call(cwd = root)
+
+      os.copy(cliPath, root / "scala")
+      os.perms.set(root / "scala", "rwxr-xr-x")
+
+      os.proc(root / "scala", "compile", "--help").call(cwd = root)
+      os.proc(root / "scala", "run", "--help").call(cwd = root)
+
+      val res = os.proc(root / "scala", "directories").call(
+        cwd = root,
+        check = false,
+        mergeErrIntoOut = true
+      )
+      expect(res.exitCode == 1)
+      val output = res.out.text()
+      expect(output.contains("directories: not found"))
+    }
+
+  if (TestUtil.isNativeCli && !Properties.isWin)
+    test("no directories command when run as scala") {
+      noDirectoriesCommandTest()
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,8 @@ import scala.build.blooprifle.BloopRifle`
`7`	`7`	`import scala.cli.CurrentParams`
`8`	`8`
`9`	`9`	`object BloopExit extends ScalaCommand[BloopExitOptions] {`
`10`		`- override def hidden = true`
	`10`	`+ override def hidden = true`
	`11`	`+ override def inSipScala = false`
`11`	`12`	`override def names: List[List[String]] = List(`
`12`	`13`	`List("bloop", "exit")`
`13`	`14`	`)`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,8 @@ import scala.concurrent.Await`
`11`	`11`	`import scala.concurrent.duration.Duration`
`12`	`12`
`13`	`13`	`object BloopStart extends ScalaCommand[BloopStartOptions] {`
`14`		`- override def hidden = true`
	`14`	`+ override def hidden = true`
	`15`	`+ override def inSipScala = false`
`15`	`16`	`override def names: List[List[String]] = List(`
`16`	`17`	`List("bloop", "start")`
`17`	`18`	`)`