sbt findbugs

SBT -FINDBUGS-通过SBT内的findbugs静态代码分析

此SBT插件使您可以在Great Findbugs工具的帮助下分析（Java）代码。它为此目的定义了findbugs SBT操作。

通过将以下内容添加到project/plugins.sbt ：安装插件：

addSbtPlugin( " com.github.sbt " % " sbt-findbugs " % " <version> " )

然后使用sbt findbugs运行插件。这将在target/scala-xx/findugs/report.xml中生成findbugs报告。

定义排除/包括过滤器

定义过滤器内联

只需将Scala内联XML用于设置，例如：

findbugsIncludeFilters := Some (< FindBugsFilter >
  < Match >
    < Class name = " de.johoop.Meep " />
  </ Match >
</ FindBugsFilter >)

使用过滤器文件

您还可以以更常规的方式从文件中读取过滤器设置：

findbugsIncludeFilters := Some (baseDirectory.value / " findbugs-include-filters.xml " )

或者，当您的配置被拉开并以前发布到本地存储库时：

findbugsIncludeFilters := {
  val configFiles = update.value.select(module = moduleFilter(name = " velvetant-sonar " ))
  val configFile = configFiles.headOption flatMap { zippedFile =>
    IO .unzip(zippedFile, target.value / " rules " ) find (_.name contains " velvetant-sonar-findbugs.xml " )
  }

  configFile map scala.xml. XML .loadFile orElse sys.error( " unable to find config file in update report " )
}

设置

（另请参见Findbugs文档）

findbugsReportType

• 描述：可选选择Findbugs报告的输出格式。
• 接受： Some(FindbugsReportType.{Xml, Html, PlainHtml, FancyHtml, FancyHistHtml, Emacs, Xdoc})
• 默认值： Some(FindbugsReportType.Xml)

findbugsReportPath

• 描述：报告文件的目标路径要生成（可选）。
• 接受：任何法律文件路径
• 默认值： Some(crossTarget.value / "findbugs" / "report.xml")

findbugsPriority

• 描述：根据优先级抑制错误报告。
• 接受： FindbugsPriority.{Relaxed, Low, Medium, High}
• 默认值： FindbugsPriority.Medium

findbugsEffort

• 描述：决定要投入多少努力。
• 接受： FindbugsEffort.{Minimum, Default, Maximum}
• 默认值： FindbugsEffort.Default

findbugsOnlyAnalyze

• 描述：可选，定义应分析哪些软件包/类。
• 接受：包含软件包和类List[String]的选项。
• 默认值： None （含义：分析所有内容）。

findbugsMaxMemory

• 描述：最大内存量以允许Findbugs（在MB中）。
• 接受：任何合理数量的内存作为整数值
• 默认值： 1024

findbugsAnalyzeNestedArchives

• 描述： Findbugs是否应该分析嵌套档案。
• 接受： true和false
• 默认值： true

findbugsSortReportByClassNames

• 描述：报告的错误实例是否应按类名进行排序。
• 接受： true和false
• 默认值： false

findbugsIncludeFilters

• 描述：可选的过滤器文件XML内容定义静态分析中包含哪些错误实例。
• 接受： None和Option[Node]
• 默认值： None （没有包含过滤器）。

findbugsExcludeFilters

• 描述：可选的过滤文件XML内容定义在静态分析中排除哪些错误实例。
• 接受： None和Some[Node]
• 默认值： None （没有排除过滤器）。

findbugsAnalyzedPath

• 描述：要分析类的路径。
• 接受：任何sbt.Path
• 默认值： Seq(classDirectory in Compile value)

贡献者

感谢@asflierl和@anishathalye的贡献！

执照

版权（C）Joachim Hofer和贡献者

版权所有。

该程序和随附的材料可根据Eclipse公共许可证v1.0的条款提供，该条款随附该分发，可在http://www.eclipse.org/legal/legal/epl-v10.html上找到。