sbt findbugs

SBT -Findbugs - Analisis kode statis melalui FindBugs dari dalam SBT

Plug-in SBT ini memungkinkan Anda untuk menganalisis kode (Java) Anda dengan bantuan alat FindBugs yang hebat. Ini mendefinisikan tindakan SBT findbugs untuk tujuan itu.

Instal plugin dengan menambahkan yang berikut ini ke project/plugins.sbt :

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

Dan kemudian jalankan plugin dengan sbt findbugs . Ini akan menghasilkan laporan FindBugs di target/scala-xx/findugs/report.xml .

Mendefinisikan Kecualikan/Sertakan Filter

Mendefinisikan filter inline

Cukup gunakan Scala Inline XML untuk pengaturan, misalnya:

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

Menggunakan file filter

Anda juga dapat membaca pengaturan filter dari file dengan cara yang lebih konvensional:

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

Atau, ketika konfigurasi Anda di -zip dan sebelumnya diterbitkan ke repo lokal:

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

Pengaturan

(Lihat juga dokumentasi FindBugs)

findbugsReportType

• Deskripsi: Secara opsional memilih format output untuk laporan FindBugs.
• Menerima: Some(FindbugsReportType.{Xml, Html, PlainHtml, FancyHtml, FancyHistHtml, Emacs, Xdoc})
• Default: Some(FindbugsReportType.Xml)

findbugsReportPath

• Deskripsi: Jalur target dari file laporan untuk menghasilkan (opsional).
• Menerima: jalur file hukum apa pun
• Default: Some(crossTarget.value / "findbugs" / "report.xml")

findbugsPriority

• Deskripsi: Menekan pelaporan bug berdasarkan prioritas.
• Menerima: FindbugsPriority.{Relaxed, Low, Medium, High}
• Default: FindbugsPriority.Medium

findbugsEffort

• Deskripsi: Putuskan berapa banyak upaya untuk dianalisis.
• Menerima: FindbugsEffort.{Minimum, Default, Maximum}
• Default: FindbugsEffort.Default

findbugsOnlyAnalyze

• Deskripsi: Secara opsional, tentukan paket/kelas mana yang harus dianalisis.
• Menerima: opsi yang berisi List[String] paket dan kelas.
• Default: None (artinya: menganalisis semuanya).

findbugsMaxMemory

• Deskripsi: Jumlah maksimum memori untuk memungkinkan findbugs (dalam MB).
• Menerima: jumlah memori yang wajar sebagai nilai integer
• Default: 1024

findbugsAnalyzeNestedArchives

• Deskripsi: Apakah FindBugs harus menganalisis arsip bersarang atau tidak.
• Menerima: true dan false
• Default: true

findbugsSortReportByClassNames

• Deskripsi: Apakah instance bug yang dilaporkan harus diurutkan berdasarkan nama kelas atau tidak.
• Menerima: true dan false
• Default: false

findbugsIncludeFilters

• Deskripsi: File filter opsional konten XML yang mendefinisikan instance bug mana yang akan disertakan dalam analisis statis.
• Menerima: None dan Option[Node]
• Default: None (tidak ada filter termasuk).

findbugsExcludeFilters

• Deskripsi: File Filter Opsional Konten XML Menentukan instance bug mana yang akan dikecualikan dalam analisis statis.
• Menerima: None dan Some[Node]
• Default: None (tidak ada filter mengecualikan).

findbugsAnalyzedPath

• Deskripsi: Jalan menuju kelas yang akan dianalisis.
• Menerima: sbt.Path apa pun
• Default: Seq(classDirectory in Compile value)

Kontributor

Terima kasih kepada @Asflierl dan @anishathalye atas kontribusi mereka!

Lisensi

Hak Cipta (C) Joachim Hofer & Kontributor

Semua hak dilindungi undang -undang.

Program ini dan materi yang menyertainya tersedia berdasarkan ketentuan Lisensi Publik Eclipse v1.0 yang menyertai distribusi ini, dan tersedia di http://www.eclipse.org/legal/epl-v10.html