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上找到。