我们有许多较小的 sbt 项目,我们希望将它们分开(没有多项目构建)。然而,我们希望在构建之间共享配置。为此,我们目前还有另一个项目,所有项目都将其用作其 project/project/Build.scala 文件中的库依赖项。通过这种方式,我们能够仅使用内置 sbt 功能来集中构建配置。
我们还没有弄清楚如何集中插件特定的构建配置。例如,我们在多项服务中使用 sbt-assemble。我们正在调整程序集 mergeStrategy 并希望在所有项目中使用它。我们如何重用配置?
此外,我们如何自动使某些 sbt 插件可用于我们的所有构建,例如程序集或 scalariform 插件,而无需手动将其添加到每个构建中?
最佳答案
这是我们想到的自动插件的使用模式之一。 自动插件可以依赖 sbt-assemble 或 sbt-scalariform 并将设置自动引入所有项目。
build.sbt
sbt-your-company 可以将 sbt-scalariform 作为库依赖项包含在 build.sbt
中,如下所示:
lazy val commonSettings = Seq(
organization := "com.example",
version := "0.1.0"
)
lazy val root = (project in file(".")).
settings(
commonSettings ++
addSbtPlugin("com.typesafe.sbt" % "sbt-scalariform" % "1.3.0")
: _*).
settings(
sbtPlugin := true,
name := "sbt-your-company",
// other settings here
)
由于 addSbtPlugin(...)
通常只出现在 project/plugins.sbt
中,这可能有点奇怪,但是如果你看看 的实现>addSbtPlugin
基本上是 libraryDependency
,带有一些额外的属性:
def addSbtPlugin(dependency: ModuleID): Setting[Seq[ModuleID]] =
libraryDependencies <+= (sbtBinaryVersion in update, scalaBinaryVersion in update) { (sbtV, scalaV) => sbtPluginExtra(dependency, sbtV, scalaV) }
src/main/scala/foo/houserules/FormatPlugin.scala
自动插件添加的功能之一是能够基于其他插件触发插件。通过触发基于 plugins.JvmPlugin
的插件,您可以有效地创建默认启用的插件。这是一个名为 FormatPlugin
的示例插件:
package foo
package houserules
import sbt._
import Keys._
import com.typesafe.sbt.SbtScalariform.{ ScalariformKeys => sr, _ }
object FormatPlugin extends AutoPlugin {
override def requires = plugins.JvmPlugin
override def trigger = allRequirements
override def projectSettings: Seq[Def.Setting[_]] = baseSettings
lazy val baseSettings: Seq[Setting[_]] = scalariformSettings ++ Seq(
sr.preferences := formatPrefs
)
def formatPrefs = {
import scalariform.formatter.preferences._
FormattingPreferences().setPreference(AlignSingleLineCaseStatements, true)
}
}
此插件引入了 sbt-scalariform 的 scalariformSettings
和自定义格式首选项。
用法
您所要做的就是将 sbt-your-company 包含到您的构建中。
如果您的某个项目想要选择退出 FormatPlugin
,您可以使用 disablePlugins(...)
。请参阅Using plugins .
有关完整示例,另请参阅 sbt-houserules我刚刚创建。 (巧合的是,我一直想为 sbt 模块化创建这个。)
内部插件的其他用途
您还可以使用自动插件来配置其他内容,例如公共(public)库的版本(例如 Akka 版本),或排除所有日志库等。
关于scala - 如何在多个项目之间共享 sbt 插件配置?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/28521226/