Shebang compatibility

When running shebang files, the system constructs a command from by concatenating shebang line, input file name and program arguments. This means we need a special parsing mode that would accept only a single input, and treat everything that comes after the input as program arguments
VirtusLab · Nov 24, 2021 · 23fb2ea · 23fb2ea
1 parent 04aad10
commit 23fb2ea
Show file tree

Hide file tree

Showing 9 changed files with 90 additions and 7 deletions.
diff --git a/modules/cli/src/main/scala/scala/cli/ScalaCli.scala b/modules/cli/src/main/scala/scala/cli/ScalaCli.scala
@@ -31,6 +31,7 @@ object ScalaCli extends CommandsEntryPoint {
     Package,
     Run,
     SetupIde,
+    Shebang,
     Test,
     Update,
     Version

diff --git a/modules/cli/src/main/scala/scala/cli/commands/Run.scala b/modules/cli/src/main/scala/scala/cli/commands/Run.scala
@@ -31,7 +31,7 @@ object Run extends ScalaCommand[RunOptions] {
         inputs.workspace,
         inputs.projectName,
         build,
-        args.unparsed,
+        options.shared.programArgs(args),
         logger,
         allowExecve = allowTerminate,
         exitOnError = allowTerminate,

diff --git a/modules/cli/src/main/scala/scala/cli/commands/SharedOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/SharedOptions.scala
@@ -99,7 +99,7 @@ final case class SharedOptions(
   @Hidden
     defaultForbiddenDirectories: Boolean = true,
   @Hidden
-    forbid: List[String] = Nil
+    forbid: List[String] = Nil,
 ) {
   // format: on
 
@@ -192,9 +192,18 @@ final case class SharedOptions(
 
   lazy val coursierCache = coursier.coursierCache(logging.logger.coursierLogger)
 
+  def programArgs(args: RemainingArgs) = args.unparsed
+
+  def inputArgs(args: RemainingArgs) = args.remaining
+
   def inputsOrExit(
     args: RemainingArgs,
     defaultInputs: () => Option[Inputs] = () => Inputs.default()
+  ): Inputs = inputsOrExit0(inputArgs(args), defaultInputs)
+
+  def inputsOrExit0(
+    args: Seq[String],
+    defaultInputs: () => Option[Inputs] = () => Inputs.default()
   ): Inputs = {
     val download: String => Either[String, Array[Byte]] = { url =>
       val artifact = Artifact(url).withChanging(true)
@@ -209,7 +218,7 @@ final case class SharedOptions(
       .map(os.Path(_, Os.pwd))
       .map(Inputs.ResourceDirectory(_))
     val inputs = Inputs(
-      args.remaining,
+      args,
       Os.pwd,
       directories.directories,
       defaultInputs = defaultInputs,

diff --git a/modules/cli/src/main/scala/scala/cli/commands/Shebang.scala b/modules/cli/src/main/scala/scala/cli/commands/Shebang.scala
@@ -0,0 +1,24 @@
+package scala.cli.commands
+
+import caseapp._
+
+final case class ShebangOptions() {}
+
+object ShebangOptions {
+  implicit lazy val parser: Parser[ShebangOptions] = Parser.derive
+  implicit lazy val help: Help[ShebangOptions]     = Help.derive
+}
+
+object Shebang extends ScalaCommand[ShebangOptions] {
+  override lazy val finalHelp: Help[_] = Run.finalHelp
+
+  def run(options: ShebangOptions, args0: RemainingArgs): Unit = {
+    val args = args0.remaining
+    val firstInputPosition = for {
+      (_, options) <- Run.parser.detailedParse(args.drop(1), true).toOption
+    } yield options.remaining.size
+    val (p1, p2) = args.splitAt(args.size - firstInputPosition.getOrElse(0) + 2)
+    val trueArgs = p1 ++ List("--") ++ p2
+    Run.main(trueArgs.toArray)
+  }
+}
diff --git a/modules/integration/src/test/scala/scala/cli/integration/RunTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/RunTestDefinitions.scala
@@ -1049,7 +1049,7 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
     val inputs = TestInputs(
       Seq(
         os.rel / "MyScript.scala" ->
-          """#!/usr/bin/env scala-cli
+          """#!/usr/bin/env -S scala-cli shebang
             |object MyScript {
             |  def main(args: Array[String]): Unit =
             |    println("Hello" + args.map(" " + _).mkString)
@@ -1140,5 +1140,19 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
       expect(p.out.text().trim == "16")
     }
   }
-
+  if (!Properties.isWin)
+    test("CLI args passed to shebang script") {
+      val inputs = TestInputs(
+        Seq(
+          os.rel / "f.sc" -> s"""|#!/usr/bin/env -S ${TestUtil.cli.mkString(" ")} shebang -S 2.13
+                                 |using scala $actualScalaVersion
+                                 |println(args.toList)""".stripMargin
+        )
+      )
+      inputs.fromRoot { root =>
+        os.perms.set(root / "f.sc", os.PermSet.fromString("rwx------"))
+        val p = os.proc("./f.sc", "1", "2", "3", "-v").call(cwd = root)
+        expect(p.out.text().trim == "List(1, 2, 3, -v)")
+      }
+    }
 }
diff --git a/website/docs/cookbooks/scala-scripts.md b/website/docs/cookbooks/scala-scripts.md
@@ -33,7 +33,7 @@ Hello from Scala .*, Java .*
 Alternatively, you can add a "shebang" header to your script, make it executable, and execute it directly with `scala-cli`. For example, given this script with a header that invokes `scala-cli`:
 
 ```scala title=HelloScriptSheBang.sc
-#!/usr/bin/env scala-cli
+#!/usr/bin/env -S scala-cli shebang
 
 val sv = scala.util.Properties.versionNumberString
 
@@ -59,7 +59,7 @@ Hello from Scala .*, Java .*
 You can also pass command line arguments to Scala scripts:
 
 ```scala title=ScriptArguments.sc
-#!/usr/bin/env scala-cli
+#!/usr/bin/env -S scala-cli shebang
 println(args(1))
 ```
 

diff --git a/website/docs/reference/cli-options.md b/website/docs/reference/cli-options.md
@@ -23,6 +23,7 @@ Aliases: `-q`
 
 Available in commands:
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 
 
 <!-- Automatically generated, DO NOT EDIT MANUALLY -->
@@ -94,6 +95,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -161,6 +163,7 @@ Available in commands:
 - [`package`](./commands.md#package)
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -183,6 +186,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -214,6 +218,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -254,6 +259,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -331,6 +337,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 - [`update`](./commands.md#update)
 - [`version`](./commands.md#version)
@@ -423,6 +430,7 @@ Binary directory
 Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -451,6 +459,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -494,6 +503,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -521,6 +531,7 @@ Available in commands:
 - [`export`](./commands.md#export)
 - [`package`](./commands.md#package)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 
 
 <!-- Automatically generated, DO NOT EDIT MANUALLY -->
@@ -765,6 +776,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -808,6 +820,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -865,6 +878,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -898,6 +912,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -1002,6 +1017,7 @@ Available in commands:
 - [`package`](./commands.md#package)
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 

diff --git a/website/docs/reference/commands.md b/website/docs/reference/commands.md
@@ -212,6 +212,8 @@ Accepts options:
 - [setup IDE](./cli-options.md#setup-ide-options)
 - [shared](./cli-options.md#shared-options)
 
+## `shebang`
+
 ## `test`
 
 Compile and test Scala code

diff --git a/website/docs/reference/directives.md b/website/docs/reference/directives.md
@@ -71,6 +71,17 @@ Add Java options
 #### Examples
 `using javaOpt -Xmx2g -Dsomething=a`
 
+### Main class
+
+Specify default main class
+
+`using main-class `_main class_
+
+`using mainClass `_main class_
+
+#### Examples
+`using main-class helloWorld`
+
 ### Platform
 
 Set the default platform to Scala.JS or Scala Native
@@ -106,6 +117,12 @@ Manually add a resource directory to the class path
 #### Examples
 `using resource "./resources"`
 
+### Scala Native options
+
+Add Scala Native options
+
+directive using usage
+
 ### Scala version
 
 Set the default Scala version