Merge pull request #1213 from wleczny/output-option-for-using-directives

Define `output` option for `package` command with using directives

Author: wleczny

modules/build/src/test/scala/scala/build/tests/PackagingUsingDirectiveTests.scala

@@ -34,4 +34,21 @@ class PackagingUsingDirectiveTests extends munit.FunSuite {
     }
   }
 
+  test("output") {
+    val output = "foo"
+    val inputs = TestInputs(
+      os.rel / "Bar.scala" ->
+        s"""//> using packaging.output "$output"
+           |def hello() = println("hello")
+           |""".stripMargin
+    )
+    inputs.withLoadedBuild(buildOptions, buildThreads, bloopConfig) { (_, _, maybeBuild) =>
+      val maybePackageOutput  = maybeBuild.options.notForBloopOptions.packageOptions.output
+      val packageOutputString = maybePackageOutput.getOrElse("None")
+      val index               = packageOutputString.lastIndexOf('/')
+      val packageName         = packageOutputString.drop(index + 1)
+      expect(packageName == output)
+    }
+  }
+
 }

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

@@ -248,7 +248,8 @@ object Package extends ScalaCommand[PackageOptions] {
         case _                                                  => "app"
       }
 
-      val dest = outputOpt
+      val packageOutput = build.options.notForBloopOptions.packageOptions.output
+      val dest = outputOpt.orElse(packageOutput)
         .orElse {
           build.sources.defaultMainClass
             .map(n => n.drop(n.lastIndexOf('.') + 1))

modules/cli/src/main/scala/scala/cli/commands/util/PackageOptionsUtil.scala

@@ -58,6 +58,7 @@ object PackageOptionsUtil {
             launcherApp = packager.launcherApp,
             maintainer = packager.maintainer,
             description = packager.description,
+            output = output,
             packageTypeOpt = packageTypeOpt,
             logoPath = packager.logoPath.map(os.Path(_, os.pwd)),
             macOSidentifier = packager.identifier,

modules/directives/src/main/scala/scala/build/preprocessing/directives/UsingPackagingDirectiveHandler.scala

@@ -18,20 +18,26 @@ case object UsingPackagingDirectiveHandler extends UsingDirectiveHandler {
   def description = "Set parameters for packaging"
   def usage =
     """using packaging.packageType [package type]
+      |using packaging.output [destination path]
       |using packaging.provided [module]
       |""".stripMargin
 
   override def usageMd =
-    """`using packaging.packageType `"package type"
+    """`//> using packaging.packageType `"package type"
+      |
+      |`//> using packaging.output `"destination path"
+      |
       |""".stripMargin
 
   override def examples = Seq(
-    "using packaging.packageType \"assembly\"",
-    "using packaging.provided \"org.apache.spark::spark-sql\""
+    "//> using packaging.packageType \"assembly\"",
+    "//> using packaging.output \"foo\"",
+    "//> using packaging.provided \"org.apache.spark::spark-sql\""
   )
 
   def keys = Seq(
     "packageType",
+    "output",
     "provided"
   ).map("packaging." + _)
 
@@ -72,6 +78,10 @@ case object UsingPackagingDirectiveHandler extends UsingDirectiveHandler {
               )
             ))
         }
+      case "packaging.output" =>
+        val value0 = value(getValue)
+        val path   = os.Path(value0.value, os.pwd)
+        PackageOptions(output = Option(path.toString))
       case "packaging.provided" =>
         val values0 = value(getValues)
         val modules = value {

modules/options/src/main/scala/scala/build/options/PackageOptions.scala

@@ -9,6 +9,7 @@ final case class PackageOptions(
   launcherApp: Option[String] = None,
   maintainer: Option[String] = None,
   description: Option[String] = None,
+  output: Option[String] = None,
   packageTypeOpt: Option[PackageType] = None,
   logoPath: Option[os.Path] = None,
   macOSidentifier: Option[String] = None,

website/docs/commands/package.md

@@ -362,3 +362,27 @@ scala-cli package --msi --output path.msi Hello.scala
 * launcher-app
 * exit-dialog
 * logo-path
+
+## Using directives
+
+Instead of passing the `package` options directly from bash, it is possible to pass some of them with [using directives](/docs/guides/using-directives).
+
+### packaging.packageType
+
+This using directive allows to define the type of the package generated by the `package` command. For example:
+
+```
+//> using packaging.packageType "assembly"
+```
+
+Available types: `assembly`, `raw-assembly`, `bootstrap`, `library`, `source`, `doc`, `spark`, `js`, `native`, `docker`, `graalvm`, `deb`, `dmg`, `pkg`, `rpm`, `msi`.
+
+### packaging.output
+
+This using directive allows to define the destination path of the package generated by the `package` command. For example:
+
+```
+//> using packaging.output "foo"
+```
+
+This using directive allows to create a package named `foo` inside the current directory.

website/docs/reference/directives.md

@@ -109,13 +109,18 @@ Specify default main class
 
 Set parameters for packaging
 
-`using packaging.packageType `"package type"
+`//> using packaging.packageType `"package type"
+
+`//> using packaging.output `"destination path"
+
 
 
 #### Examples
-`using packaging.packageType "assembly"`
+`//> using packaging.packageType "assembly"`
+
+`//> using packaging.output "foo"`
 
-`using packaging.provided "org.apache.spark::spark-sql"`
+`//> using packaging.provided "org.apache.spark::spark-sql"`
 
 ### Platform