Add support of running script files with no extension using shebang subcommand

MaciejG604 · MaciejG604 · commit 1879288e4f9d · 2023-01-24T09:40:10.000+01:00
diff --git a/modules/build/src/main/scala/scala/build/Build.scala b/modules/build/src/main/scala/scala/build/Build.scala
@@ -233,6 +233,7 @@ object Build {
           () => options.javaHome().value.javaCommand
         ),
         logger,
+        options.scriptOptions.runWithShebang,
         options.suppressWarningOptions.suppressDirectivesInMultipleFilesWarning
       )
     }
diff --git a/modules/build/src/main/scala/scala/build/CrossSources.scala b/modules/build/src/main/scala/scala/build/CrossSources.scala
@@ -126,6 +126,7 @@ object CrossSources {
     inputs: Inputs,
     preprocessors: Seq[Preprocessor],
     logger: Logger,
+    isRunWithShebang: Option[Boolean],
     suppressDirectivesInMultipleFilesWarning: Option[Boolean],
     maybeRecoverOnError: BuildException => Option[BuildException] = e => Some(e)
   ): Either[BuildException, (CrossSources, Inputs)] = either {
@@ -161,7 +162,10 @@ object CrossSources {
         .flatMap(_.internal.extraSourceFiles)
         .distinct
     val inputsElemFromDirectives =
-      value(resolveInputsFromSources(sourcesFromDirectives, inputs.enableMarkdown))
+      value(resolveInputsFromSources(
+        sourcesFromDirectives,
+        inputs.enableMarkdown
+      ))
     val preprocessedSourcesFromDirectives = value(preprocessSources(inputsElemFromDirectives))
     val allInputs                         = inputs.add(inputsElemFromDirectives)
 
@@ -261,7 +265,10 @@ object CrossSources {
     (CrossSources(paths, inMemory, defaultMainClassOpt, resourceDirs, buildOptions), allInputs)
   }
 
-  private def resolveInputsFromSources(sources: Seq[Positioned[os.Path]], enableMarkdown: Boolean) =
+  private def resolveInputsFromSources(
+    sources: Seq[Positioned[os.Path]],
+    enableMarkdown: Boolean
+  ) =
     sources.map { source =>
       val sourcePath   = source.value
       lazy val dir     = sourcePath / os.up
diff --git a/modules/build/src/main/scala/scala/build/bsp/BspImpl.scala b/modules/build/src/main/scala/scala/build/bsp/BspImpl.scala
@@ -101,6 +101,7 @@ final class BspImpl(
           () => buildOptions.javaHome().value.javaCommand
         ),
         persistentLogger,
+        isRunWithShebang = None,
         suppressDirectivesInMultipleFilesWarning = None,
         maybeRecoverOnError(Scope.Main)
       ).left.map((_, Scope.Main))
diff --git a/modules/build/src/main/scala/scala/build/input/Inputs.scala b/modules/build/src/main/scala/scala/build/input/Inputs.scala
@@ -261,7 +261,8 @@ object Inputs {
     download: String => Either[String, Array[Byte]],
     stdinOpt: => Option[Array[Byte]],
     acceptFds: Boolean,
-    enableMarkdown: Boolean
+    enableMarkdown: Boolean,
+    isRunWithShebang: Boolean
   ): Seq[Either[String, Seq[Element]]] = args.zipWithIndex.map {
     case (arg, idx) =>
       lazy val path      = os.Path(arg, cwd)
@@ -297,6 +298,8 @@ object Inputs {
       else if os.isDir(path) then Right(Seq(Directory(path)))
       else if acceptFds && arg.startsWith("/dev/fd/") then
         Right(Seq(VirtualScript(content, arg, os.sub / s"input-${idx + 1}.sc")))
+      else if isRunWithShebang && String(content).startsWith("#!") then
+        Right(Seq(Script(dir, subPath)))
       else {
         val msg =
           if (os.exists(path))
@@ -320,10 +323,11 @@ object Inputs {
     forcedWorkspace: Option[os.Path],
     enableMarkdown: Boolean,
     allowRestrictedFeatures: Boolean,
-    extraClasspathWasPassed: Boolean
+    extraClasspathWasPassed: Boolean,
+    isRunWithShebang: Boolean
   ): Either[BuildException, Inputs] = {
     val validatedArgs: Seq[Either[String, Seq[Element]]] =
-      validateArgs(args, cwd, download, stdinOpt, acceptFds, enableMarkdown)
+      validateArgs(args, cwd, download, stdinOpt, acceptFds, enableMarkdown, isRunWithShebang)
     val validatedSnippets: Seq[Either[String, Seq[Element]]] =
       validateSnippets(scriptSnippetList, scalaSnippetList, javaSnippetList, markdownSnippetList)
     val validatedArgsAndSnippets = validatedArgs ++ validatedSnippets
@@ -364,7 +368,8 @@ object Inputs {
     forcedWorkspace: Option[os.Path] = None,
     enableMarkdown: Boolean = false,
     allowRestrictedFeatures: Boolean,
-    extraClasspathWasPassed: Boolean
+    extraClasspathWasPassed: Boolean,
+    isRunWithShebang: Boolean
   ): Either[BuildException, Inputs] =
     if (
       args.isEmpty && scriptSnippetList.isEmpty && scalaSnippetList.isEmpty && javaSnippetList.isEmpty &&
@@ -388,7 +393,8 @@ object Inputs {
         forcedWorkspace,
         enableMarkdown,
         allowRestrictedFeatures,
-        extraClasspathWasPassed
+        extraClasspathWasPassed,
+        isRunWithShebang
       )
 
   def default(): Option[Inputs] = None
diff --git a/modules/build/src/test/scala/scala/build/tests/SourcesTests.scala b/modules/build/src/test/scala/scala/build/tests/SourcesTests.scala
@@ -56,6 +56,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -90,6 +91,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -122,6 +124,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -154,6 +157,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -189,6 +193,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -226,6 +231,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -255,6 +261,7 @@ class SourcesTests extends munit.FunSuite {
         inputs,
         preprocessors,
         TestLogger(),
+        isRunWithShebang = None,
         suppressDirectivesInMultipleFilesWarning = None
       )
       expect(crossSources.isLeft)
@@ -277,6 +284,7 @@ class SourcesTests extends munit.FunSuite {
         inputs,
         preprocessors,
         TestLogger(),
+        isRunWithShebang = None,
         suppressDirectivesInMultipleFilesWarning = None
       ).isLeft)
     }
@@ -334,6 +342,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -367,6 +376,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -403,6 +413,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -430,6 +441,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -468,6 +480,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         ).orThrow
       val scopedSources = crossSources.scopedSources(BuildOptions()).orThrow
@@ -508,6 +521,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         )
       crossSources match {
@@ -529,6 +543,7 @@ class SourcesTests extends munit.FunSuite {
           inputs,
           preprocessors,
           TestLogger(),
+          isRunWithShebang = None,
           suppressDirectivesInMultipleFilesWarning = None
         )
       crossSources match {
diff --git a/modules/build/src/test/scala/scala/build/tests/TestInputs.scala b/modules/build/src/test/scala/scala/build/tests/TestInputs.scala
@@ -44,7 +44,8 @@ final case class TestInputs(
         tmpDir,
         forcedWorkspace = forcedWorkspaceOpt.map(_.resolveFrom(tmpDir)),
         allowRestrictedFeatures = true,
-        extraClasspathWasPassed = false
+        extraClasspathWasPassed = false,
+        isRunWithShebang = false
       )
       res match {
         case Left(err)     => throw new Exception(err)
diff --git a/modules/cli/src/main/scala/scala/cli/commands/bsp/Bsp.scala b/modules/cli/src/main/scala/scala/cli/commands/bsp/Bsp.scala
@@ -59,6 +59,7 @@ object Bsp extends ScalaCommand[BspOptions] {
                 () => buildOptions0.javaHome().value.javaCommand
               ),
               persistentLogger,
+              buildOptions0.scriptOptions.runWithShebang,
               buildOptions0.suppressWarningOptions.suppressDirectivesInMultipleFilesWarning
             ).map(_._2).getOrElse(initialInputs)
 
diff --git a/modules/cli/src/main/scala/scala/cli/commands/clean/Clean.scala b/modules/cli/src/main/scala/scala/cli/commands/clean/Clean.scala
@@ -21,7 +21,8 @@ object Clean extends ScalaCommand[CleanOptions] {
       defaultInputs = () => Inputs.default(),
       forcedWorkspace = options.workspace.forcedWorkspaceOpt,
       allowRestrictedFeatures = ScalaCli.allowRestrictedFeatures,
-      extraClasspathWasPassed = false
+      extraClasspathWasPassed = false,
+      isRunWithShebang = false
     ) match {
       case Left(message) =>
         System.err.println(message)
diff --git a/modules/cli/src/main/scala/scala/cli/commands/dependencyupdate/DependencyUpdate.scala b/modules/cli/src/main/scala/scala/cli/commands/dependencyupdate/DependencyUpdate.scala
@@ -36,6 +36,7 @@ object DependencyUpdate extends ScalaCommand[DependencyUpdateOptions] {
           () => buildOptions.javaHome().value.javaCommand
         ),
         logger,
+        buildOptions.scriptOptions.runWithShebang,
         buildOptions.suppressWarningOptions.suppressDirectivesInMultipleFilesWarning
       ).orExit(logger)
 
diff --git a/modules/cli/src/main/scala/scala/cli/commands/export/Export.scala b/modules/cli/src/main/scala/scala/cli/commands/export/Export.scala
@@ -38,6 +38,7 @@ object Export extends ScalaCommand[ExportOptions] {
           () => buildOptions.javaHome().value.javaCommand
         ),
         logger,
+        buildOptions.scriptOptions.runWithShebang,
         buildOptions.suppressWarningOptions.suppressDirectivesInMultipleFilesWarning
       )
     }
diff --git a/modules/cli/src/main/scala/scala/cli/commands/publish/PublishSetup.scala b/modules/cli/src/main/scala/scala/cli/commands/publish/PublishSetup.scala
@@ -83,6 +83,7 @@ object PublishSetup extends ScalaCommand[PublishSetupOptions] {
           () => cliBuildOptions.javaHome().value.javaCommand
         ),
         logger,
+        isRunWithShebang = None,
         suppressDirectivesInMultipleFilesWarning = None
       ).orExit(logger)
 
diff --git a/modules/cli/src/main/scala/scala/cli/commands/setupide/SetupIde.scala b/modules/cli/src/main/scala/scala/cli/commands/setupide/SetupIde.scala
@@ -40,6 +40,7 @@ object SetupIde extends ScalaCommand[SetupIdeOptions] {
             () => options.javaHome().value.javaCommand
           ),
           logger,
+          options.scriptOptions.runWithShebang,
           options.suppressWarningOptions.suppressDirectivesInMultipleFilesWarning
         )
       }
diff --git a/modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala
@@ -177,11 +177,16 @@ final case class SharedOptions(
   @Recurse
     input: SharedInputOptions = SharedInputOptions(),
   @Recurse
-  helpGroups: HelpGroupOptions = HelpGroupOptions(),
+    helpGroups: HelpGroupOptions = HelpGroupOptions(),
 
   @Hidden
     strictBloopJsonCheck: Option[Boolean] = None,
 
+  @Hidden
+  @Tag(tags.implementation)
+  @HelpMessage("Has the run been initiated using the shebang subcommand")
+    runWithShebang: Option[Boolean] = None,
+
   @Name("output-directory")
   @Name("d")
   @Name("destination")
@@ -309,7 +314,8 @@ final case class SharedOptions(
         platform = platformOpt.map(o => Positioned(List(Position.CommandLine()), o))
       ),
       scriptOptions = bo.ScriptOptions(
-        codeWrapper = None
+        codeWrapper = None,
+        runWithShebang
       ),
       scalaJsOptions = scalaJsOptions(js),
       scalaNativeOptions = scalaNativeOptions(native),
@@ -529,7 +535,8 @@ final case class SharedOptions(
       javaSnippetList = allJavaSnippets,
       markdownSnippetList = allMarkdownSnippets,
       enableMarkdown = markdown.enableMarkdown,
-      extraClasspathWasPassed = extraJarsAndClassPath.nonEmpty
+      extraClasspathWasPassed = extraJarsAndClassPath.nonEmpty,
+      runWithShebang = runWithShebang.getOrElse(false)
     )
 
   def allScriptSnippets: List[String]   = snippet.scriptSnippet ++ snippet.executeScript
@@ -544,7 +551,8 @@ final case class SharedOptions(
       SharedOptions.downloadInputs(coursierCache),
       SharedOptions.readStdin(logger = logger),
       !Properties.isWin,
-      enableMarkdown = true
+      enableMarkdown = true,
+      runWithShebang.getOrElse(false)
     )
 
   def strictBloopJsonCheckOrDefault: Boolean =
@@ -582,7 +590,8 @@ object SharedOptions {
     javaSnippetList: List[String],
     markdownSnippetList: List[String],
     enableMarkdown: Boolean = false,
-    extraClasspathWasPassed: Boolean = false
+    extraClasspathWasPassed: Boolean = false,
+    runWithShebang: Boolean = false
   ): Either[BuildException, Inputs] = {
     val resourceInputs = resourceDirs
       .map(os.Path(_, Os.pwd))
@@ -606,7 +615,8 @@ object SharedOptions {
       forcedWorkspace = forcedWorkspaceOpt,
       enableMarkdown = enableMarkdown,
       allowRestrictedFeatures = ScalaCli.allowRestrictedFeatures,
-      extraClasspathWasPassed = extraClasspathWasPassed
+      extraClasspathWasPassed = extraClasspathWasPassed,
+      isRunWithShebang = runWithShebang
     )
     maybeInputs.map { inputs =>
       val forbiddenDirs =
diff --git a/modules/cli/src/main/scala/scala/cli/commands/shebang/Shebang.scala b/modules/cli/src/main/scala/scala/cli/commands/shebang/Shebang.scala
@@ -19,7 +19,7 @@ object Shebang extends ScalaCommand[ShebangOptions] {
 
   override def runCommand(options: ShebangOptions, args: RemainingArgs, logger: Logger): Unit =
     Run.runCommand(
-      options.runOptions,
+      options.runOptions.copy(shared = options.runOptions.shared.copy(runWithShebang = Some(true))),
       args.remaining.headOption.toSeq,
       args.remaining.drop(1),
       () => None,
diff --git a/modules/integration/src/test/scala/scala/cli/integration/RunScriptTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/RunScriptTestDefinitions.scala
@@ -326,4 +326,18 @@ trait RunScriptTestDefinitions { _: RunTestDefinitions =>
         expect(p.out.trim() == "List(1, 2, 3, -v)")
       }
     }
+
+  test("script file with shebang line and no extension run with scala-cli shebang") {
+    val inputs = TestInputs(
+      os.rel / "script" ->
+        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 / "script", os.PermSet.fromString("rwx------"))
+      val p = os.proc("./script", "1", "2", "3", "-v").call(cwd = root)
+      expect(p.out.trim() == "List(1, 2, 3, -v)")
+    }
+  }
 }
diff --git a/modules/options/src/main/scala/scala/build/options/ScriptOptions.scala b/modules/options/src/main/scala/scala/build/options/ScriptOptions.scala
@@ -3,7 +3,8 @@ package scala.build.options
 import scala.build.internal.CodeWrapper
 
 final case class ScriptOptions(
-  codeWrapper: Option[CodeWrapper] = None
+  codeWrapper: Option[CodeWrapper] = None,
+  runWithShebang: Option[Boolean] = None
 )
 
 object ScriptOptions {
diff --git a/website/docs/reference/cli-options.md b/website/docs/reference/cli-options.md
@@ -1408,6 +1408,11 @@ Add dependency for stubs needed to make $ivy and $dep imports to work.
 ### `--strict-bloop-json-check`
 
 [Internal]
+### `--run-with-shebang`
+
+[Internal]
+Has the run been initiated using the shebang subcommand
+
 ### `--compilation-output`
 
 Aliases: `--compile-out`, `--compile-output`, `-d`, `--destination`, `--output-directory`
diff --git a/website/docs/reference/scala-command/cli-options.md b/website/docs/reference/scala-command/cli-options.md
diff --git a/website/docs/reference/scala-command/runner-specification.md b/website/docs/reference/scala-command/runner-specification.md

Original file line number	Diff line number	Diff line change
`@@ -233,6 +233,7 @@ object Build {`
`233`	`233`	`() => options.javaHome().value.javaCommand`
`234`	`234`	`),`
`235`	`235`	`logger,`
	`236`	`+ options.scriptOptions.runWithShebang,`
`236`	`237`	`options.suppressWarningOptions.suppressDirectivesInMultipleFilesWarning`
`237`	`238`	`)`
`238`	`239`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ object Export extends ScalaCommand[ExportOptions] {`
`38`	`38`	`() => buildOptions.javaHome().value.javaCommand`
`39`	`39`	`),`
`40`	`40`	`logger,`
	`41`	`+ buildOptions.scriptOptions.runWithShebang,`
`41`	`42`	`buildOptions.suppressWarningOptions.suppressDirectivesInMultipleFilesWarning`
`42`	`43`	`)`
`43`	`44`	`}`