在 jar 中包含生成的资源 (SBT)

Question

我一直在编写一个 SBT 插件，它可以将资源生成到 resource_managed 中。我现在希望将这些生成的资源作为 SBT 文档详细信息包含在生成的 jar 中：

Generating resources:

默认情况下，生成的资源不包含在打包的源工件中。为此，请像添加其他映射一样添加它们。请参阅将文件添加到包中

我已阅读文档，但老实说，我不知道该怎么做。谁能解释一下或将我指向另一个这样做的项目，以便我了解他们是如何做到的？

Answer 1

首先澄清一下，它们包含在包含已编译类的 jar 中。它们不包含在包含源的 jar 中。

默认情况下，生成的资源不包含在打包中 源工件。

对于packageBin，应该已经包含了生成的文件——只要确保从生成器方法返回所有生成的文件。假设您想将它们打包到源工件中，这就是您必须做的。

假设您有一个生成器来生成属性文件。

lazy val generatePropertiesTask = Def.task {
  val file = (resourceManaged in Compile).value / "stack-overflow" / "res.properties"
  val contents = s"name=${name.value}\nversion=${version.value}"
  IO.write(file, contents)
  Seq(file)
}

resourceGenerators in Compile += generatePropertiesTask.taskValue

要将其包含在生成的源代码中，您必须告诉 sbt 必须将 res.properties 复制到生成的源代码工件中的位置。生成打包源的任务称为packageSrc，因此您必须设置映射scoped to that task。

mappings in (Compile, packageSrc) += {
   ((resourceManaged in Compile).value / "stack-overflow" / "res.properties") -> "path/in/jar/res.properties"
}

因为您的生成器可以生成许多任务，而手动映射每个任务将是一项繁琐的任务，所以 sbt 为您提供了一个 utility 来一次映射多个路径。

mappings in (Compile, packageSrc) ++= {
  val allGeneratedFiles = ((resourceManaged in Compile).value ** "*") filter { _.isFile }
  allGeneratedFiles.get pair relativeTo((resourceManaged in Compile).value)
}

第一行使用path finders查找所有生成的文件，第二行将它们映射到目标jar中的路径。