sbt findbugs

SBT -Findbugs - statische Codeanalyse über Findbugs aus SBT

Mit diesem SBT-Plug-In können Sie Ihren (Java) Code mit Hilfe des Great Findbugs-Tools analysieren. Es definiert eine findbugs -SBT -Aktion zu diesem Zweck.

Installieren Sie das Plugin, indem Sie Folgendes zu project/plugins.sbt addieren.

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

Und führen Sie das Plugin mit sbt findbugs aus. Dadurch wird ein FindBugs-Bericht in target/scala-xx/findugs/report.xml generiert.

Definieren von Filtern ausschließen/einschließen

Filter definieren

Verwenden Sie einfach Scala Inline XML für die Einstellung, zum Beispiel:

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

Verwenden von Filterdateien

Sie können die Filtereinstellungen auch auf herkömmliche Weise aus Dateien lesen:

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

Oder wenn Ihre Konfiguration geschliffen und zuvor in einem lokalen Repo veröffentlicht wird:

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

Einstellungen

(Siehe auch die Findbugs -Dokumentation)

findbugsReportType

• Beschreibung: Wählen Sie optional das Ausgabeformat für den Bericht von FindBugs aus.
• Akzeptiert: Some(FindbugsReportType.{Xml, Html, PlainHtml, FancyHtml, FancyHistHtml, Emacs, Xdoc})
• Standard: Some(FindbugsReportType.Xml)

findbugsReportPath

• Beschreibung: Zielpfad der zu generierenden Berichtsdatei (optional).
• Akzeptiert: Jeder legale Dateipfad
• Standard: Some(crossTarget.value / "findbugs" / "report.xml")

findbugsPriority

• Beschreibung: Unterdrückung der Berichterstattung von Fehler basierend auf Priorität.
• Akzeptiert: FindbugsPriority.{Relaxed, Low, Medium, High}
• Standard: FindbugsPriority.Medium

findbugsEffort

• Beschreibung: Entscheiden Sie, wie viel Anstrengung in die Analyse eingesetzt wird.
• Akzeptiert: FindbugsEffort.{Minimum, Default, Maximum}
• Standard: FindbugsEffort.Default

findbugsOnlyAnalyze

• Beschreibung: Definieren Sie optional, welche Pakete/Klassen analysiert werden sollen.
• Akzeptiert: Eine Option mit einer List[String] von Paketen und Klassen.
• Standard: None (was bedeutet: Analysieren Sie alles).

findbugsMaxMemory

• Beschreibung: Maximale Speichermenge, um FindBugs (in MB) zu ermöglichen.
• Akzeptiert: Jede angemessene Menge an Speicher als Ganzzahlwert
• Standard: 1024

findbugsAnalyzeNestedArchives

• Beschreibung: Ob FindBugs verschachtelte Archive analysieren oder nicht.
• Akzeptiert: true und false
• Standard: true

findbugsSortReportByClassNames

• Beschreibung: Ob die gemeldeten Fehlerinstanzen nach Klassennamen sortiert werden sollten oder nicht.
• Akzeptiert: true und false
• Standard: false

findbugsIncludeFilters

• Beschreibung: Optionale Filterdatei XML -Inhalt, die festlegen, welche Fehlerinstanzen in die statische Analyse einbezogen werden sollen.
• Akzeptiert: None und Option[Node]
• Standardeinstellung: None (keine Filter einschließen).

findbugsExcludeFilters

• Beschreibung: Optionale Filterdatei XML -Inhalt, die festlegen, welche Fehlerinstanzen in der statischen Analyse ausgeschlossen werden sollen.
• Akzeptiert: None und Some[Node]
• Standard: None (keine ausschließenden Filter).

findbugsAnalyzedPath

• Beschreibung: Der Pfad zu den zu analysierenden Klassen.
• Akzeptiert: Jeder sbt.Path
• Standard: Seq(classDirectory in Compile value)

Mitwirkende

Vielen Dank an @asflierl und @anishathalye für ihre Beiträge!

Lizenz

Copyright (c) Joachim Hofer & Mitwirkende

Alle Rechte vorbehalten.

Dieses Programm und die dazugehörigen Materialien werden gemäß den Bestimmungen der Eclipse Public Lizenz V1.0 zur Verfügung gestellt, die diese Verteilung begleitet und unter http://www.eclipse.org/legal/epl-v10.html verfügbar ist