sbt findbugs

SBT-FindBugs - Analyse de code statique via FindBugs à partir de SBT

Ce plug-in SBT vous permet d'analyser votre code (Java) à l'aide de l'outil Great Findbugs. Il définit une action SBT findbugs à cette fin.

Installez le plugin en ajoutant ce qui suit à project/plugins.sbt :

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

Puis exécutez le plugin avec sbt findbugs . Cela générera un rapport FindBugs dans target/scala-xx/findugs/report.xml .

Définir l'exclusion / inclure des filtres

Définition des filtres en ligne

Utilisez simplement Scala Inline XML pour le paramètre, par exemple:

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

Utilisation de fichiers filtrants

Vous pouvez également lire les paramètres du filtre à partir des fichiers de manière plus conventionnelle:

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

Ou, lorsque votre configuration est zippée et publiée précédemment dans un dépôt local:

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

Paramètres

(Voir aussi la documentation Findbugs)

findbugsReportType

• Description: Sélectionne éventuellement le format de sortie pour le rapport FindBugs.
• Accepte: Some(FindbugsReportType.{Xml, Html, PlainHtml, FancyHtml, FancyHistHtml, Emacs, Xdoc})
• Par défaut: Some(FindbugsReportType.Xml)

findbugsReportPath

• Description: chemin cible du fichier de rapport à générer (facultatif).
• Accepte: tout chemin de dossier juridique
• Par défaut: Some(crossTarget.value / "findbugs" / "report.xml")

findbugsPriority

• Description: Supprimez la déclaration des bogues en fonction de la priorité.
• Accepte: FindbugsPriority.{Relaxed, Low, Medium, High}
• Par défaut: FindbugsPriority.Medium

findbugsEffort

• Description: Décidez de l'effort à consacrer à l'analyse.
• Accepte: FindbugsEffort.{Minimum, Default, Maximum}
• Par défaut: FindbugsEffort.Default

findbugsOnlyAnalyze

• Description: éventuellement, définissez les packages / classes doivent être analysés.
• Accepte: une option contenant une List[String] de packages et de classes.
• Par défaut: None (Signification: analysez tout).

findbugsMaxMemory

• Description: Montant maximum de mémoire pour permettre les Findbugs (en MB).
• Accepte: toute quantité raisonnable de mémoire comme valeur entière
• Par défaut: 1024

findbugsAnalyzeNestedArchives

• Description: Si Findbugs doit analyser ou non les archives imbriquées.
• Accepte: true et false
• Par défaut: true

findbugsSortReportByClassNames

• Description: si les instances de bogue signalées doivent être triées par nom de classe ou non.
• Accepte: true et false
• Par défaut: false

findbugsIncludeFilters

• Description: Contenu XML de fichier de filtre facultatif définissant les instances de bogue à inclure dans l'analyse statique.
• Accepte: None et Option[Node]
• Par défaut: None (non inclure les filtres).

findbugsExcludeFilters

• Description: Contenu XML de fichier de filtre facultatif définissant les instances de bogue à exclure dans l'analyse statique.
• Accepte: None et Some[Node]
• Par défaut: None (pas d'exclusion des filtres).

findbugsAnalyzedPath

• Description: Le chemin vers les classes à analyser.
• Accepte: tout sbt.Path
• Par défaut: Seq(classDirectory in Compile value)

Contributeurs

Merci à @asflierl et @anishathalye pour leurs contributions!

Licence

Copyright (c) Joachim Hofer et contributeurs

Tous droits réservés.

Ce programme et les documents qui l'accompagnent sont mis à disposition en vertu des termes de la licence publique Eclipse v1.0 qui accompagne cette distribution, et est disponible sur http://www.eclipse.org/legal/epl-v10.html