在标准任务之前/之后自动运行自定义任务

Question

我经常想在运行其中一项标准任务之前进行一些自定义。我意识到我可以按照我想要的顺序创建执行现有任务的新任务，但是我发现这很麻烦，并且开发人员错过了他应该运行 my-compile 而不是 compile 的机会很大并且导致难以修复错误.

所以我想定义一个自定义任务（例如 prepare-app）并将其注入现有任务的依赖关系树（例如 package-bin），以便每次有人调用 package-bin 我的自定义任务都会在它之前运行。

我试过这样做

  def mySettings = {
    inConfig(Compile)(Seq(prepareAppTask <<= packageBin in Compile map { (pkg: File) =>
      // fiddle with the /target folder before package-bin makes it into a jar
    })) ++
    Seq(name := "my project", version := "1.0")
  }

  lazy val prepareAppTask = TaskKey[Unit]("prepare-app")

但它不会在将编译输出打包到 jar 之前由 package-bin 自动执行。那么如何更改上述代码以在正确的时间运行？

更一般地说，我在哪里可以找到有关挂钩到其他任务（如编译）的信息，是否有一种通用方法可以确保在调用标准任务之前和之后运行您自己的任务？

Answer 1

Tasks 的 SBT 文档记录了扩展现有任务（请参阅 Modifying an Existing Task 部分）。

类似这样的：

compile in Compile <<= (compile in Compile) map { _ => 
  // what you want to happen after compile goes here 
}

其实还有另一种方式——定义你的任务依赖于编译

prepareAppTask := (whatever you want to do) dependsOn compile

然后修改 packageBin 以依赖它：

packageBin <<= packageBin dependsOn prepareAppTask

（以上所有内容都未经测试，但我希望一般的推力应该有效）。

Answer 2

作为@Paul Butcher 先前回答的更新，这可以在 SBT 1.x 版本中以稍微不同的方式完成，因为不再支持 <<==。我举了一个示例任务示例，在我在我的一个项目中使用的编译之前运行：

lazy val wsdlImport = TaskKey[Unit]("wsdlImport", "Generates Java classes from WSDL")

wsdlImport := {
  import sys.process._
  "./wsdl/bin/wsdl_import.sh" !
  // or do whatever stuff you need
}

(compile in Compile) := ((compile in Compile) dependsOn wsdlImport).value

这与 1.x 之前的做法非常相似。

另外，official SBT docs 还建议了另一种方式，它基本上是任务的组合（而不是依赖关系层次结构）。以与上述相同的示例：

(compile in Compile) := {
  val w = wsdlImport.value
  val c = (compile in Compile).value
  // you can add more tasks to composition or perform some actions with them
  c
}

感觉在某些情况下提供了更大的灵活性，尽管对我来说第一个示例看起来更简洁一些。

已在 SBT 1.2.3 上测试，但也应与其他 1.x 一起使用。