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 " )

または、構成がZippedで、以前にローカルリポジトリに公開された場合：

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レポートの出力形式を選択します。
• Accepts： 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

• 説明： FindBugがネストされたアーカイブを分析するかどうか。
• 受け入れる： 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）ヨアヒム・ホーファー＆貢献者

無断転載を禁じます。

このプログラムと付随する資料は、この分布に付随するEclipse Public License v1.0の条件の下で利用可能になり、http：//www.eclipse.org/legal/epl-v10.htmlで入手できます。