SBT插件:在运行taskKey之前,使用inputTask覆盖settingKey吗?

时间:2018-12-31 21:37:07

标签: scala sbt

我有一个task,它以settingA和settingB`作为输入来运行。

我希望有一个inputTask,它将覆盖settingA并以task的新值运行settingA

那怎么办?

谢谢。

更多详细信息:

任务类似于:

Def.taskDyn {
   val settingAValue = settingA.value
   val settingBValue = settingB.value

   Def.task {
      settingAValue + settingBValue
   }
}

人们会在他们的build.sbt中使用它:

settingA := 3
settingB := 1

然后sbt task将产生4

我想要一个inputTask,例如:

Def.inputTaskDyn {
  val newValue = customParser.parsed

  Def.taskDyn {
     val settingCValue = settingC.value

     Def.task {
        // call task with settingA = newValue ? 
     }
  }
}

修改:

如果这样更容易,则settingA可以是Task而不是Setting

1 个答案:

答案 0 :(得分:1)

您可以这样做:

lazy val setting1 = settingKey[String]("")
lazy val setting2 = settingKey[String]("")

lazy val task1 = taskKey[Unit]("")
lazy val inputTask1 = inputKey[Unit]("")

setting1 := "a"
setting2 := "b"

task1 := {
  println(setting1.value + setting2.value)
}

inputTask1 := {
  val newValue = Parsers.spaceDelimited("arg").parsed.head
  val curState = state.value
  val updState = Project.extract(curState).appendWithoutSession(
    Vector(setting1 := newValue),
    curState
  )
  Project.extract(updState).runTask(task1, updState)
}

基本上,您可以依靠SBT构建状态是完全自省的事实,并且可以修改它并以新状态运行任务。

但是,文档建议不要在任务中使用它。通常,SBT模型是所有设置实际上都是不可变的-您不能也不应该在任务执行期间修改它们。相反,建议为此使用commands

commands += command1

lazy val command1 = Command.args("command1", "") { (state, args) =>
  val updState = Project.extract(state).appendWithoutSession(
    Vector(setting1 := args.head),
    state
  )
  val (finalState, _) = Project.extract(updState).runTask(task1, updState)
  finalState
}

请注意,该命令在执行后将setting1设置为提供的值。如果您不想这样做,则应返回原始状态值,或者最好将setting1的原始值保存到局部变量中,并在任务运行后将其恢复原状:

lazy val command1 = Command.args("command1", "") { (state, args) =>
  val newValue = args.head
  val originalValue = Project.extract(state).get(setting1)

  val updState = Project.extract(state).appendWithoutSession(
    Vector(setting1 := newValue),
    state
  )
  val (nextState, _) = Project.extract(updState).runTask(task1, updState)

  Project.extract(nextState).appendWithoutSession(
    Vector(setting1 := originalValue),
    nextState
  )
}

不幸的是,API不是很直观(例如,您必须多次调用Project.extract),但这是执行所需操作的正确方法。注意,可以通过多种方式构造命令,包括您拥有自己的Parser的情况;为了简单起见,我在上面使用了Command.args