Add packIncludedProjectScopes setting for filtering project dependency scopes (#592)

* add include dependency mappings key

* Update src/main/scala/xerial/sbt/pack/PackPlugin.scala

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* add additional test for case where mappings sequence is empty

* Revert "Update src/main/scala/xerial/sbt/pack/PackPlugin.scala"

This reverts commit dd6d132.

* Rename includedDependencyMappings to packIncludedProjectScopes

- Follow pack* naming convention for consistency with other settings
- Use "project scopes" instead of "dependency mappings" to avoid
  confusion with JAR dependency mapping
- Update documentation with clearer description and example

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Michał Zyga <michal.zyga@softwaremill.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Taro L. Saito <leo@xerial.org>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

Author: 5 people

README.md

@@ -201,6 +201,9 @@ the `packCopyDependenciesTarget` setting.
 By default, a symbolic link will be created.  By setting `packCopyDependenciesUseSymbolicLinks` to `false`, 
 the files will be copied instead of symlinking.   A symbolic link is faster and uses less disk space.
 
+By default, only dependencies from child modules with scope `compile->` will be copied.  By setting
+`packIncludedProjectScopes` to a list of scopes (e.g., `Seq("compile->", "test->")`), you can control which project dependencies are included.
+
 It can be used e.g. for copying dependencies of a webapp to `WEB-INF/lib`
 
 See an [example](src/sbt-test/sbt-pack/copy-dependencies) project.

src/main/scala/xerial/sbt/pack/PackPlugin.scala

@@ -96,6 +96,8 @@ object PackPlugin extends AutoPlugin with PackArchive {
       taskKey[Boolean]("""use symbolic links instead of copying for <packCopyDependencies>.
         		|The use of symbolic links allows faster processing and save disk space.
       	  """.stripMargin)
+    val packIncludedProjectScopes =
+      settingKey[Seq[String]]("project dependency scopes to include when packaging, default is Seq(\"compile->\")")
 
     val packArchivePrefix = settingKey[String]("prefix of (prefix)-(version).(format) archive file name")
     val packArchiveName   = settingKey[String]("archive file name. Default is (project-name)-(version)")
@@ -157,7 +159,8 @@ object PackPlugin extends AutoPlugin with PackArchive {
           Runtime,
           discoveredMainClasses,
           state.value,
-          packExclude.value
+          packExclude.value,
+          packIncludedProjectScopes.value
         )
       Def.task {
         mainClasses.value
@@ -166,7 +169,14 @@ object PackPlugin extends AutoPlugin with PackArchive {
     }.value,
     packAllUnmanagedJars := Def.taskDyn {
       val allUnmanagedJars =
-        getFromSelectedProjects(thisProjectRef.value, Runtime, unmanagedJars, state.value, packExclude.value)
+        getFromSelectedProjects(
+          thisProjectRef.value,
+          Runtime,
+          unmanagedJars,
+          state.value,
+          packExclude.value,
+          packIncludedProjectScopes.value
+        )
       Def.task { allUnmanagedJars.value }
     }.value,
     Def.derive(
@@ -178,7 +188,8 @@ object PackPlugin extends AutoPlugin with PackArchive {
               c,
               packageBin,
               state.value,
-              packExcludeLibJars.value
+              packExcludeLibJars.value,
+              packIncludedProjectScopes.value
             )
           ) ++ c.extendsConfigs.flatMap(libJarsFromConfiguration)
 
@@ -244,6 +255,7 @@ object PackPlugin extends AutoPlugin with PackArchive {
       }
     ),
     packCopyDependenciesUseSymbolicLinks := true,
+    packIncludedProjectScopes            := Seq("compile->"),
     packCopyDependenciesTarget           := target.value / "lib",
     Def.derive(
       packCopyDependencies := {
@@ -507,34 +519,28 @@ object PackPlugin extends AutoPlugin with PackArchive {
     })
   )
 
-  private def getFromAllProjects[T](
-      contextProject: ProjectRef,
-      config: Configuration,
-      targetTask: TaskKey[T],
-      state: State
-  ): Task[Seq[(T, ProjectRef)]] =
-    getFromSelectedProjects(contextProject, config, targetTask, state, Seq.empty)
-
   private def getFromSelectedProjects[T](
       contextProject: ProjectRef,
       config: Configuration,
       targetTask: TaskKey[T],
       state: State,
-      exclude: Seq[String]
+      exclude: Seq[String],
+      packIncludedProjectScopes: Seq[String]
   ): Task[Seq[(T, ProjectRef)]] = {
     val extracted = Project.extract(state)
     val structure = extracted.structure
 
     def transitiveDependencies(currentProject: ProjectRef): Seq[ProjectRef] = {
       def isExcluded(p: ProjectRef) = exclude.contains(p.project)
 
-      def isCompileConfig(cp: ClasspathDep[ProjectRef]) = cp.configuration.forall(_.contains("compile->"))
+      def isMatchingConfig(cp: ClasspathDep[ProjectRef]) =
+        cp.configuration.forall(c => packIncludedProjectScopes.exists(c.contains(_)))
 
       // Traverse all dependent projects
       val children = Project
         .getProject(currentProject, structure)
         .toSeq
-        .flatMap { _.dependencies.filter(isCompileConfig).map(_.project) }
+        .flatMap { _.dependencies.filter(isMatchingConfig).map(_.project) }
 
       (currentProject +: (children flatMap transitiveDependencies)) filterNot (isExcluded)
     }

src/sbt-test/sbt-pack/copy-dependencies/build.sbt

@@ -51,7 +51,7 @@ lazy val module3 =
 
 lazy val module4 =
   project
-    .dependsOn(module2)
+    .dependsOn(module2, module3 % "test->compile")
     .settings(commonSettings)
     .settings(
       libraryDependencies ++= Seq(

src/sbt-test/sbt-pack/copy-dependencies/test

@@ -61,3 +61,27 @@ $exists module4/target/WEB-INF/lib/commons-digester-2.1.jar
 $exists module4/target/WEB-INF/lib/commons-logging-1.1.1.jar
 $exists module4/target/WEB-INF/lib/slf4j-api-1.7.6.jar
 -$exists module4/target/WEB-INF/lib/snappy-java-1.1.1.6.jar
+
+>set module4 / packIncludedProjectScopes := Seq("compile->", "test->")
+>module4 / packCopyDependencies
+#$exec ls module4/target/WEB-INF/lib
+-$exists module4/target/WEB-INF/lib/module2-0.1.jar
+$exists module4/target/WEB-INF/lib/module3-0.1.jar
+$exists module4/target/WEB-INF/lib/module4-0.1.jar
+$exists module4/target/WEB-INF/lib/commons-collections-3.2.1.jar
+$exists module4/target/WEB-INF/lib/commons-digester-2.1.jar
+$exists module4/target/WEB-INF/lib/commons-logging-1.1.1.jar
+$exists module4/target/WEB-INF/lib/slf4j-api-1.7.6.jar
+-$exists module4/target/WEB-INF/lib/snappy-java-1.1.1.6.jar
+
+>set module4 / packIncludedProjectScopes := Seq()
+>module4 / packCopyDependencies
+#$exec ls module4/target/WEB-INF/lib
+-$exists module4/target/WEB-INF/lib/module2-0.1.jar
+-$exists module4/target/WEB-INF/lib/module3-0.1.jar
+$exists module4/target/WEB-INF/lib/module4-0.1.jar
+$exists module4/target/WEB-INF/lib/commons-collections-3.2.1.jar
+$exists module4/target/WEB-INF/lib/commons-digester-2.1.jar
+$exists module4/target/WEB-INF/lib/commons-logging-1.1.1.jar
+$exists module4/target/WEB-INF/lib/slf4j-api-1.7.6.jar
+-$exists module4/target/WEB-INF/lib/snappy-java-1.1.1.6.jar