sbt findbugs

SBT -FindBugs - Análisis de código estático a través de FindBugs desde STB

Este complemento SBT le permite analizar su código (Java) con la ayuda de la herramienta Great FindBugs. Define una acción findbugs SBT para ese propósito.

Instale el complemento agregando lo siguiente a project/plugins.sbt :

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

Y luego ejecute el complemento con sbt findbugs . Esto generará un informe FindBugs en target/scala-xx/findugs/report.xml .

Definir excluir/incluir filtros

Definición de filtros en línea

Simplemente use el XML en línea de Scala para la configuración, por ejemplo:

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

Usando archivos de filtro

También puede leer la configuración del filtro de los archivos de una manera más convencional:

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

O, cuando su configuración se contague y se publica previamente en un repositorio 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 " )
}

Ajustes

(Ver también la documentación de FindBugs)

findbugsReportType

• Descripción: Opcionalmente selecciona el formato de salida para el informe FindBugs.
• Acepta: Some(FindbugsReportType.{Xml, Html, PlainHtml, FancyHtml, FancyHistHtml, Emacs, Xdoc})
• Valor predeterminado: Some(FindbugsReportType.Xml)

findbugsReportPath

• Descripción: ruta de destino del archivo de informe para generar (opcional).
• Acepta: cualquier ruta de archivo legal
• Valor predeterminado: Some(crossTarget.value / "findbugs" / "report.xml")

findbugsPriority

• Descripción: Suprimir los informes de errores basados ​​en la prioridad.
• Acepta: FindbugsPriority.{Relaxed, Low, Medium, High}
• Valor predeterminado: FindbugsPriority.Medium

findbugsEffort

• Descripción: Decide cuánto esfuerzo poner en análisis.
• Acepta: FindbugsEffort.{Minimum, Default, Maximum}
• Valor predeterminado: FindbugsEffort.Default

findbugsOnlyAnalyze

• Descripción: Opcionalmente, defina qué paquetes/clases deben analizarse.
• Acepta: una opción que contiene una List[String] de paquetes y clases.
• Valor predeterminado: None (Significado: Analizar todo).

findbugsMaxMemory

• Descripción: Cantidad máxima de memoria para permitir FindBugs (en MB).
• Acepta: cualquier cantidad razonable de memoria como valor entero
• Valor predeterminado: 1024

findbugsAnalyzeNestedArchives

• Descripción: Si FindBugs debe analizar archivos anidados o no.
• Acepta: true y false
• Valor predeterminado: true

findbugsSortReportByClassNames

• Descripción: Si las instancias de errores informadas deben ordenarse por nombre de clase o no.
• Acepta: true y false
• Valor predeterminado: false

findbugsIncludeFilters

• Descripción: Contenido de XML de archivo de filtro opcional que define qué instancias de errores incluir en el análisis estático.
• Acepta: None y Option[Node]
• Valor predeterminado: None (no incluye filtros).

findbugsExcludeFilters

• Descripción: Contenido de XML de archivo de filtro opcional que define qué errores de error excluir en el análisis estático.
• Acepta: None y Some[Node]
• Valor predeterminado: None (sin filtros de exclusión).

findbugsAnalyzedPath

• Descripción: La ruta a las clases a analizar.
• Acepta: cualquier sbt.Path
• Valor predeterminado: Seq(classDirectory in Compile value)

Colaboradores

¡Gracias a @asflierl y @anishathalye por sus contribuciones!

Licencia

Copyright (c) Joachim Hofer & Colaboradores

Reservados todos los derechos.

Este programa y los materiales adjuntos están disponibles bajo los términos de la Licencia Pública de Eclipse V1.0 que acompaña a esta distribución, y está disponible en http://www.eclipse.org/legal/epl-v10.html