Clean up references to scala-cli in SIP mode (#1547)

Author: lwronski

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

@@ -5,7 +5,7 @@ import caseapp.*
 import scala.cli.commands.common.HasLoggingOptions
 
 // format: off
-@HelpMessage("Prints directories used by `scala-cli`")
+@HelpMessage("Prints directories used by Scala CLI")
 final case class DirectoriesOptions(
   @Recurse
     directories: SharedDirectoriesOptions = SharedDirectoriesOptions(),

modules/cli-options/src/main/scala/scala/cli/commands/DocOptions.scala

@@ -19,7 +19,7 @@ final case class DocOptions(
   @Name("f")
     force: Boolean = false,
   @Group("Doc")
-  @HelpMessage("Control if scala CLI should use default options for scaladoc, true by default. Use `--default-scaladoc-opts:false` to not include default options.")
+  @HelpMessage("Control if Scala CLI should use default options for scaladoc, true by default. Use `--default-scaladoc-opts:false` to not include default options.")
   @ExtraName("defaultScaladocOpts")
     defaultScaladocOptions: Option[Boolean] = None,
 ) extends HasSharedOptions

modules/cli-options/src/main/scala/scala/cli/commands/InstallHomeOptions.scala

@@ -5,15 +5,15 @@ import caseapp.*
 import scala.cli.commands.common.HasLoggingOptions
 
 // format: off
-@HelpMessage("Install `scala-cli` in a sub-directory of the home directory")
+@HelpMessage("Install Scala CLI in a sub-directory of the home directory")
 final case class InstallHomeOptions(
   @Recurse
     logging: LoggingOptions = LoggingOptions(),
   @Group("InstallHome")
     scalaCliBinaryPath: String,
   @Group("InstallHome")
   @Name("f")
-  @HelpMessage("Overwrite `scala-cli`, if it exists")
+  @HelpMessage("Overwrite if it exists")
     force: Boolean = false,
   @Hidden
   @HelpMessage("Binary name")

modules/cli-options/src/main/scala/scala/cli/commands/ShebangOptions.scala

@@ -8,7 +8,7 @@ import scala.cli.commands.common.HasSharedOptions
   """|Like `run`, but more handy from shebang scripts
      |
      |This command is equivalent to `run`, but it changes the way
-     |`scala-cli` parses its command-line arguments in order to be compatible
+     |Scala CLI parses its command-line arguments in order to be compatible
      |with shebang scripts.
      |
      |Normally, inputs and scala-cli options can be mixed. Program have to be specified after `--`

modules/cli-options/src/main/scala/scala/cli/commands/VersionOptions.scala

@@ -5,11 +5,11 @@ import caseapp.*
 import scala.cli.commands.common.HasLoggingOptions
 
 // format: off
-@HelpMessage("Print `scala-cli` version")
+@HelpMessage("Print version")
 final case class VersionOptions(
   @Recurse
     logging: LoggingOptions = LoggingOptions(),
-  @HelpMessage("Show only plain scala-cli version")
+  @HelpMessage("Show only plain version")
   @Name("cli")
     cliVersion: Boolean = false,
   @HelpMessage("Show only plain scala version") 

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

@@ -34,7 +34,8 @@ object ScalaCli {
 
   private var isSipScala      = checkName("scala") || checkName("scala-cli-sip")
   def allowRestrictedFeatures = !isSipScala
-
+  def fullRunnerName          = if (isSipScala) "Scala code runner" else "Scala CLI"
+  def baseRunnerName          = if (isSipScala) "scala" else "scala-cli"
   private def isGraalvmNativeImage: Boolean =
     sys.props.contains("org.graalvm.nativeimage.imagecode")
 
@@ -131,10 +132,10 @@ object ScalaCli {
             // Suggest workaround of https://github.com/VirtusLab/scala-cli/pull/865
             // for https://github.com/VirtusLab/scala-cli/issues/828
             System.err.println(
-              """Running
-                |  export SCALA_CLI_VENDORED_ZIS=true
-                |before running Scala CLI might fix the issue.
-                |""".stripMargin
+              s"""Running
+                 |  export SCALA_CLI_VENDORED_ZIS=true
+                 |before running $fullRunnerName might fix the issue.
+                 |""".stripMargin
             )
           case _ =>
         }
@@ -145,7 +146,7 @@ object ScalaCli {
 
   private def warnRequiresJava17(): Unit =
     System.err.println(
-      s"Java >= 17 is required to run Scala CLI (found Java $javaMajorVersion)"
+      s"Java >= 17 is required to run $fullRunnerName (found Java $javaMajorVersion)"
     )
 
   private def main0(args: Array[String]): Unit = {
@@ -185,7 +186,7 @@ object ScalaCli {
       // Enable ANSI output in Windows terminal
       coursier.jniutils.WindowsAnsiTerminal.enableAnsiOutput()
 
-    new ScalaCliCommands(progName, isSipScala)
+    new ScalaCliCommands(progName, baseRunnerName, fullRunnerName, isSipScala)
       .main(scalaCliArgs)
   }
 }

modules/cli/src/main/scala/scala/cli/ScalaCliCommands.scala

@@ -15,6 +15,8 @@ import scala.cli.commands.publish.{Publish, PublishLocal, PublishSetup}
 
 class ScalaCliCommands(
   val progName: String,
+  baseRunnerName: String,
+  fullRunnerName: String,
   isSipScala: Boolean
 ) extends CommandsEntryPoint {
 
@@ -27,7 +29,7 @@ class ScalaCliCommands(
   private def pgpBinaryCommands = new PgpCommandsSubst
 
   private def allCommands = Seq[ScalaCommand[_]](
-    new About(isSipScala = isSipScala),
+    About,
     AddPath,
     Bloop,
     BloopExit,
@@ -64,7 +66,7 @@ class ScalaCliCommands(
     Uninstall,
     UninstallCompletions,
     Update,
-    new Version(isSipScala = isSipScala)
+    Version
   ) ++ (if (pgpUseBinaryCommands) Nil else pgpCommands.allScalaCommands.toSeq) ++
     (if (pgpUseBinaryCommands) pgpBinaryCommands.allScalaCommands.toSeq else Nil)
 
@@ -74,10 +76,10 @@ class ScalaCliCommands(
       (if (pgpUseBinaryCommands) pgpBinaryCommands.allExternalCommands.toSeq else Nil)
 
   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."
+    s"$fullRunnerName 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 =
-    """|See 'scala-cli <command> --help' to read about a specific subcommand. To see full help run 'scala-cli <command> --help-full'.
-       |To run another Scala CLI version, specify it with '--cli-version' before any other argument, like 'scala-cli --cli-version <version> args'.""".stripMargin
+    s"""|See '$baseRunnerName <command> --help' to read about a specific subcommand. To see full help run '$baseRunnerName <command> --help-full'.
+        |To run another $fullRunnerName version, specify it with '--cli-version' before any other argument, like '$baseRunnerName --cli-version <version> args'.""".stripMargin
   final override def defaultCommand = Some(actualDefaultCommand)
 
   // FIXME Report this in case-app default NameFormatter

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

@@ -7,17 +7,17 @@ import scala.build.internal.Constants
 import scala.cli.CurrentParams
 import scala.cli.commands.util.CommonOps.*
 
-class About(isSipScala: Boolean) extends ScalaCommand[AboutOptions] {
+object About extends ScalaCommand[AboutOptions] {
 
   override def group                                                         = "Miscellaneous"
   override def runCommand(options: AboutOptions, args: RemainingArgs, logger: Logger): Unit = {
-    println(Version.versionInfo(isSipScala))
+    println(Version.versionInfo)
     val newestScalaCliVersion = Update.newestScalaCliVersion(options.ghToken.map(_.get()))
     val isOutdated = CommandUtils.isOutOfDateVersion(newestScalaCliVersion, Constants.version)
     if (isOutdated)
       logger.message(
-        s"""Your Scala CLI version is outdated. The newest version is $newestScalaCliVersion
-           |It is recommended that you update Scala CLI through the same tool or method you used for its initial installation for avoiding the creation of outdated duplicates.""".stripMargin
+        s"""Your $fullRunnerName. version is outdated. The newest version is $newestScalaCliVersion
+           |It is recommended that you update $fullRunnerName through the same tool or method you used for its initial installation for avoiding the creation of outdated duplicates.""".stripMargin
       )
   }
 }

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

@@ -30,7 +30,7 @@ class Default(
   }
 
   override def runCommand(options: DefaultOptions, args: RemainingArgs, logger: Logger): Unit = {
-    if options.version then println(Version.versionInfo(isSipScala))
+    if options.version then println(Version.versionInfo)
     else
       {
         val shouldDefaultToRun =

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

@@ -62,8 +62,8 @@ object DependencyUpdate extends ScalaCommand[DependencyUpdateOptions] {
       actionableUpdateDiagnostics.foreach(update =>
         println(s"   * ${update.oldDependency.render} -> ${update.newVersion}")
       )
-      println("""|To update all dependencies run:
-                 |    scala-cli dependency-update --all""".stripMargin)
+      println(s"""|To update all dependencies run:
+                  |    $baseRunnerName dependency-update --all""".stripMargin)
     }
   }
 
@@ -91,7 +91,9 @@ object DependencyUpdate extends ScalaCommand[DependencyUpdateOptions] {
       case (Left(file), diagnostics) =>
         diagnostics.foreach {
           diagnostic =>
-            logger.message(s"Warning: Scala CLI can't update ${diagnostic._2.suggestion} in $file")
+            logger.message(
+              s"Warning: $fullRunnerName can't update ${diagnostic._2.suggestion} in $file"
+            )
         }
     }
   }