sbt findbugs

SBT -Findbugs - Análise de código estático via findbugs de dentro do SBT

Esse plug-in SBT permite analisar seu código (Java) com a ajuda da ferramenta Great FindBugs. Ele define uma ação findbugs SBT para esse fim.

Instale o plug -in adicionando o seguinte ao project/plugins.sbt :

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

E depois execute o plug -in com sbt findbugs . Isso gerará um relatório FindBugs no target/scala-xx/findugs/report.xml .

Definindo excluir/incluir filtros

Definindo filtros embutidos

Basta usar o Scala Inline XML para a configuração, por exemplo:

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

Usando arquivos de filtro

Você também pode ler as configurações do filtro dos arquivos de uma maneira mais convencional:

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

Ou, quando sua configuração é fechada e publicada anteriormente em um repositório 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 " )
}

Configurações

(Veja também a documentação do FindBugs)

findbugsReportType

• Descrição: Opcionalmente seleciona o formato de saída para o relatório FindBugs.
• Aceita: Some(FindbugsReportType.{Xml, Html, PlainHtml, FancyHtml, FancyHistHtml, Emacs, Xdoc})
• Padrão: Some(FindbugsReportType.Xml)

findbugsReportPath

• Descrição: Caminho de destino do arquivo de relatório para gerar (opcional).
• Aceita: qualquer caminho de arquivo legal
• Padrão: Some(crossTarget.value / "findbugs" / "report.xml")

findbugsPriority

• Descrição: Suprima o relatório de bugs com base na prioridade.
• Aceita: FindbugsPriority.{Relaxed, Low, Medium, High}
• Padrão: FindbugsPriority.Medium

findbugsEffort

• Descrição: Decida quanto esforço para colocar em análise.
• Aceita: FindbugsEffort.{Minimum, Default, Maximum}
• Padrão: FindbugsEffort.Default

findbugsOnlyAnalyze

• Descrição: Opcionalmente, defina quais pacotes/classes devem ser analisados.
• Aceita: uma opção que contém uma List[String] de pacotes e classes.
• Padrão: None (Significado: Analise tudo).

findbugsMaxMemory

• Descrição: quantidade máxima de memória para permitir o findbugs (em MB).
• Aceita: qualquer quantidade razoável de memória como um valor inteiro
• Padrão: 1024

findbugsAnalyzeNestedArchives

• Descrição: Se o FindBugs deve analisar arquivos aninhados ou não.
• Aceita: true e false
• Padrão: true

findbugsSortReportByClassNames

• Descrição: se as instâncias de bug relatadas devem ser classificadas pelo nome da classe ou não.
• Aceita: true e false
• Padrão: false

findbugsIncludeFilters

• Descrição: Arquivo opcional Arquivo XML Conteúdo Definindo quais instâncias de bug a serem incluídas na análise estática.
• Aceita: None e Option[Node]
• Padrão: None (não inclui filtros).

findbugsExcludeFilters

• Descrição: Arquivo opcional Arquivo XML Conteúdo Definindo quais instâncias de erro excluir na análise estática.
• Aceita: None e Some[Node]
• Padrão: None (sem exclusão de filtros).

findbugsAnalyzedPath

• Descrição: O caminho para as classes a serem analisadas.
• Aceita: qualquer sbt.Path
• Padrão: Seq(classDirectory in Compile value)

Colaboradores

Obrigado a @asflierl e @anishathalye por suas contribuições!

Licença

Copyright (C) Joachim Hofer e colaboradores

Todos os direitos reservados.

Este programa e os materiais que o acompanham são disponibilizados nos termos da licença pública Eclipse v1.0, que acompanha essa distribuição e está disponível em http://www.eclipse.org/legal/epl-v10.html