Support simpler syntax without need for implicit conversion in SBT 2.x (#1776)

Co-authored-by: gaeljw <18280708+gaeljw@users.noreply.github.com>

fixup

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Author: gaeljw

.github/workflows/validate-pr.yml

@@ -35,6 +35,14 @@ jobs:
             java: 8
             distribution: zulu
             command: +validateUniversal
+          - os: ubuntu-latest
+            java: 8
+            distribution: zulu
+            command: validateUniversalSbt1 # No cross build, only SBT 1.x
+          - os: ubuntu-latest
+            java: 8
+            distribution: zulu
+            command: validateUniversalSbt2 # No cross build, only SBT 2.x
           - os: ubuntu-latest
             java: 8
             distribution: zulu
@@ -59,6 +67,14 @@ jobs:
             java: 8
             distribution: zulu
             command: +validateDocker
+          - os: ubuntu-latest
+            java: 8
+            distribution: zulu
+            command: validateDockerSbt1 # No cross build, only SBT 1.x
+          - os: ubuntu-latest
+            java: 8
+            distribution: zulu
+            command: validateDockerSbt2 # No cross build, only SBT 2.x
           - os: ubuntu-latest
             java: 11
             distribution: temurin

build.sbt

@@ -122,13 +122,17 @@ addCommandAlias("validate", "; clean ; update ; validateFormatting ; test")
 // tests take quite some time to run.
 // Ultimately we should run only those tests that are necessary for a change
 addCommandAlias("validateUniversal", "scripted universal/*")
+addCommandAlias("validateUniversalSbt1", "++ 2.12.20; scripted universal-sbt1/*")
+addCommandAlias("validateUniversalSbt2", "++ 3.7.3; scripted universal-sbt2/*")
 addCommandAlias("validateJar", "scripted jar/*")
 addCommandAlias("validateBash", "scripted bash/*")
 addCommandAlias("validateAsh", "scripted ash/*")
 addCommandAlias("validateGraalVMNativeImage", "scripted graalvm-native-image/*")
 addCommandAlias("validateRpm", "scripted rpm/*")
 addCommandAlias("validateDebian", "scripted debian/*")
 addCommandAlias("validateDocker", "scripted docker/*")
+addCommandAlias("validateDockerSbt1", "++ 2.12.20; scripted docker-sbt1/*")
+addCommandAlias("validateDockerSbt2", "++ 3.7.3; scripted docker-sbt2/*")
 addCommandAlias("validateJdkPackager", "scripted jdkpackager/*")
 // travis ci's jdk8 version doesn't support nested association elements.
 // error: Caused by: class com.sun.javafx.tools.ant.Info doesn't support the nested "association" element.

…pesafe/sbt/packager/MappingsHelper.scala …pesafe/sbt/packager/MappingsHelper.scalasrc/main/scala/com/typesafe/sbt/packager/MappingsHelper.scala renamed to src/main/scala-2.12/com/typesafe/sbt/packager/MappingsHelper.scala src/main/scala/com/typesafe/sbt/packager/MappingsHelper.scala renamed to src/main/scala-2.12/com/typesafe/sbt/packager/MappingsHelper.scala

@@ -0,0 +1,119 @@
+package com.typesafe.sbt.packager
+
+import sbt.{*, given}
+import sbt.Keys.fileConverter
+import sbt.io.*
+import sbtcompat.PluginCompat.*
+import xsbti.FileConverter
+
+/** A set of helper methods to simplify the writing of mappings */
+object MappingsHelper extends Mapper {
+
+  /**
+    * It lightens the build file if one wants to give a string instead of file.
+    *
+    * @example
+    *   {{{
+    * mappings in Universal ++= directory("extra").value
+    *   }}}
+    *
+    * @param sourceDir
+    * @return
+    *   mappings
+    */
+  def directory(sourceDir: String): Def.Initialize[Seq[(FileRef, String)]] =
+    Def.setting {
+      implicit val conv: FileConverter = fileConverter.value
+      directory(file(sourceDir)).map { case (f, p) =>
+        toFileRef(f) -> p
+      }
+    }
+
+  /**
+    * It lightens the build file if one wants to give a string instead of file.
+    *
+    * @example
+    *   {{{
+    * mappings in Universal ++= contentOf("extra").value
+    *   }}}
+    *
+    * @param sourceDir
+    *   as string representation
+    * @return
+    *   mappings
+    */
+  def contentOf(sourceDir: String): Def.Initialize[Seq[(FileRef, String)]] =
+    Def.setting {
+      implicit val conv: FileConverter = fileConverter.value
+      contentOf(sourceDir = file(sourceDir), conv0 = conv)
+    }
+
+  def contentOf(sourceDir: File, conv0: FileConverter): Seq[(FileRef, String)] = {
+    implicit val conv: FileConverter = conv0
+    contentOf(sourceDir).map { case (f, p) =>
+      toFileRef(f) -> p
+    }
+  }
+
+  /**
+    * Create mappings from your classpath. For example if you want to add additional dependencies, like test or model.
+    *
+    * @example
+    *   Add all test artifacts to a separated test folder
+    *   {{{
+    * mappings in Universal ++= fromClasspath((managedClasspath in Test).value, target = "test")
+    *   }}}
+    *
+    * @param entries
+    * @param target
+    * @return
+    *   a list of mappings
+    */
+  def fromClasspath(entries: Seq[Attributed[FileRef]], target: String): Seq[(FileRef, String)] =
+    fromClasspath(entries, target, _ => true)
+
+  /**
+    * Create mappings from your classpath. For example if you want to add additional dependencies, like test or model.
+    * You can also filter the artifacts that should be mapped to mappings.
+    *
+    * @example
+    *   Filter all osgi bundles
+    *   {{{
+    * mappings in Universal ++= fromClasspath(
+    *    (managedClasspath in Runtime).value,
+    *    "osgi",
+    *    artifact => artifact.`type` == "bundle"
+    * )
+    *   }}}
+    *
+    * @param entries
+    *   from where mappings should be created from
+    * @param target
+    *   folder, e.g. `model`. Must not end with a slash
+    * @param includeArtifact
+    *   function to determine if an artifact should result in a mapping
+    * @param includeOnNoArtifact
+    *   default is false. When there's no Artifact meta data remove it
+    */
+  def fromClasspath(
+    entries: Seq[Attributed[FileRef]],
+    target: String,
+    includeArtifact: PluginCompat.IncludeArtifact,
+    includeOnNoArtifact: Boolean = false
+  ): Seq[(FileRef, String)] =
+    entries.filter(attr => attr.get(artifactStr).map(includeArtifact) getOrElse includeOnNoArtifact).map { attribute =>
+      val file = attribute.data
+      val name = PluginCompat.getName(file)
+      file -> s"$target/${name}"
+    }
+
+  /**
+    * Get the mappings for the given files relative to the given directories.
+    */
+  def relative(files: Seq[File], dirs: Seq[File], conv0: FileConverter): Seq[(FileRef, String)] = {
+    implicit val conv: FileConverter = conv0
+    (files --- dirs) pair (relativeTo(dirs) | flat) map { case (f, p) =>
+      toFileRef(f) -> p
+    }
+  }
+}

src/main/scala-3/com/typesafe/sbt/packager/MappingsHelper.scala

@@ -8,8 +8,5 @@ name := "docker-build-command-test"
 
 version := "0.1.0"
 
-Docker / mappings ++= {
-  implicit val converter: FileConverter = fileConverter.value
-  PluginCompat.toFileRefsMapping(directory("src/main/resources/docker-test"))
-}
+Docker / mappings ++= directory("src/main/resources/docker-test")
 dockerBuildCommand := Seq("docker", "build", "-t", "docker-build-command-test:0.1.0", "docker-test/")

…/sbt-test/docker/build-command/build.sbt …test/docker-sbt1/build-command/build.sbtsrc/sbt-test/docker/build-command/build.sbt renamed to src/sbt-test/docker-sbt1/build-command/build.sbt src/sbt-test/docker/build-command/build.sbt renamed to src/sbt-test/docker-sbt1/build-command/build.sbt

@@ -0,0 +1,12 @@
+import xsbti.FileConverter
+import sbtcompat.PluginCompat
+import NativePackagerHelper._
+
+enablePlugins(JavaAppPackaging)
+
+name := "docker-build-command-test"
+
+version := "0.1.0"
+
+Docker / mappings ++= directory("src/main/resources/docker-test").value
+dockerBuildCommand := Seq("docker", "build", "-t", "docker-build-command-test:0.1.0", "docker-test/")