SBT 插件：传播编译器插件并在下游启用插件

Question

我看到了SBT Plugin: How to add compiler plugin as a dependency that is not propagated downstream?，但这并不能回答我的问题。

结构如下：

other plugins
    |-----> added to my own plugin
                |-----> Consumer project

consumer project 需要在自己的build.sbt 中添加addCompilerPlugin 和enablePlugins，因为other plugins。

我在my own plugin 的build.sbt 中添加了other plugins。

我应该将addCompilerPlugin 和enablePlugins 放在我的插件中的什么位置，这样consumer project 就不必自己动手了？

谢谢

Answer 1

addCompilerPlugin 只是修改特定设置键的快捷方式，而enablePlugins 是修改项目配置本身的方法。因此，这些事情处于不同的级别，因此根据您的目的进行不同的处理。

为确保启用您的插件也会启用其他插件，您需要修改插件中的requires 声明：

object YourPlugin extends AutoPlugin {
  override def requires: Plugins = FirstDependencyPlugin & SecondDependencyPlugin
}

现在，当您的插件添加到项目中时：

lazy val someProject = project.enablePlugins(YourPlugin)

那么FirstDependencyPlugin 和SecondDependencyPlugin 插件也将被启用。

要启用编译器插件，您只需要确保您的插件提供addCompilerPlugin返回的设置定义：

object YourPlugin extends AutoPlugin {
  override def projectSettings: Seq[Def.Setting[_]] = super.projectSettings ++ Vector(
    addCompilerPlugin("com.example" % "some-plugin" % "1.2.3")
  )
}

现在，当你的插件添加到项目中时，它提供的Def.Setting[_]会自动应用到这个项目中，它会使用指定的编译器插件来构建你的代码。