SBT如何在插件任务执行中使用Build.sbt中的类

Question

project/*.scala 文件中定义的任何类都可供 SBT 在构建定义代码中使用。

我希望这些类在 SBT 插件任务执行期间可用，但它们似乎不可用。

为什么会这样，我该如何解决？

我要解决的具体问题是为Scalastyle 添加自定义规则。项目does not currently support writing your own rules，但我想我可以在project/*.sbt 文件中添加一个规则，然后在Scalastyle 中使用它。

如果我在project/MyRule.scala 中定义规则，那么它在project/Build.scala 设置中可用：

object MyBuild extends Build {

  lazy val project = Project("MyProject", file("."))
    .settings(ScalastylePlugin.Settings: _*)

  // my rule is available in this classloader:
  val test = classOf[MyRule].getName

  ...
}

...但是当 ScalastylePlugin 任务运行时，它正在使用的类加载器看不到该类：

java.lang.NoClassDefFoundError: MyRule
java.net.URLClassLoader$1.run(URLClassLoader.java:202)
java.security.AccessController.doPrivileged(Native Method)
java.net.URLClassLoader.findClass(URLClassLoader.java:190)
java.lang.ClassLoader.loadClass(ClassLoader.java:307)
java.lang.ClassLoader.loadClass(ClassLoader.java:248)
java.lang.Class.forName0(Native Method)
java.lang.Class.forName(Class.java:169)
org.scalastyle.Checker$.newInstance(Checker.scala:194)
org.scalastyle.Checker$$anonfun$verifySource0$1.apply(Checker.scala:116)
org.scalastyle.Checker$$anonfun$verifySource0$1.apply(Checker.scala:116)
...
org.scalastyle.ScalastyleChecker.checkFiles(Checker.scala:64)
org.scalastyle.sbt.Tasks$.runScalastyle(Plugin.scala:121)
org.scalastyle.sbt.Tasks$.doScalastyle(Plugin.scala:90)
org.scalastyle.sbt.ScalastylePlugin$$anonfun$4$$anonfun$apply$1.apply(Plugin.scala:63)
org.scalastyle.sbt.ScalastylePlugin$$anonfun$4$$anonfun$apply$1.apply(Plugin.scala:63)
scala.Function6$$anonfun$tupled$1.apply(Function6.scala:35)
scala.Function6$$anonfun$tupled$1.apply(Function6.scala:34)
scala.Function1$$anonfun$compose$1.apply(Function1.scala:47)
sbt.$tilde$greater$$anonfun$$u2219$1.apply(TypeFunctions.scala:42)
sbt.std.Transform$$anon$4.work(System.scala:64)
sbt.Execute$$anonfun$submit$1$$anonfun$apply$1.apply(Execute.scala:237)
sbt.Execute$$anonfun$submit$1$$anonfun$apply$1.apply(Execute.scala:237)
sbt.ErrorHandling$.wideConvert(ErrorHandling.scala:18)
sbt.Execute.work(Execute.scala:244)
sbt.Execute$$anonfun$submit$1.apply(Execute.scala:237)
sbt.Execute$$anonfun$submit$1.apply(Execute.scala:237)
sbt.ConcurrentRestrictions$$anon$4$$anonfun$1.apply(ConcurrentRestrictions.scala:160)
sbt.CompletionService$$anon$2.call(CompletionService.scala:30)
java.util.concurrent.FutureTask$Sync.innerRun(FutureTask.java:303)
...
java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:908)
java.lang.Thread.run(Thread.java:619)

我在Scalastyle 任务期间检查了正在使用的类加载器，它的类路径中有所有 SBT 库依赖 jar，但没有来自 SBT 项目的类。

如何将这些类添加到其类路径中？

Answer 1

我认为不可能，因为documented in the SBT documentation

注意：在运行时，所有构建的所有插件都加载到一个单独的文件中， 用于构建的类加载器的父类加载器。这意味着 插件不会从构建定义中看到类或资源。

已编辑

基于 cmets，我认为这个解决方案可能会奏效。在project/ 中创建名为scala-style-defs 的额外项目。在那里放置你的规则。在同一个项目中使用构建定义创建build.sbt，例如

libraryDependencies += "org.scalastyle" %% "scalastyle" % "0.4.0"

resolvers += "sonatype-releases" at "https://oss.sonatype.org/content/repositories/releases/"

然后在project/创建build.sbt，内容如下

lazy val root = project.in(file(".")) dependsOn(scalastyleDefs)

lazy val scalastyleDefs = Project(id="scalastyleDefs", base=file("scala-style-defs"))

当然还有plugins.sbt

addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "0.4.0")

resolvers += "sonatype-releases" at "https://oss.sonatype.org/content/repositories/releases/"

现在在您的主项目中创建 build.sbt 并包含 scalastyle 设置

org.scalastyle.sbt.ScalastylePlugin.Settings