sbt findbugs

SBT -Findbugs - анализ статического кода через Findbugs из SBT

Этот плагин SBT позволяет проанализировать ваш (Java) код с помощью отличного инструмента Findbugs. Он определяет действие findbugs SBT для этой цели.

Установите плагин, добавив следующее в project/plugins.sbt :

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

А затем запустите плагин с sbt findbugs . Это будет генерировать отчет FindBugs в target/scala-xx/findugs/report.xml .

Определение исключения/включить фильтры

Определение встроенных фильтров

Просто используйте Scala Inline XML для настройки, например:

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

Использование файлов фильтра

Вы также можете прочитать настройки фильтра из файлов более обычным образом:

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

Или, когда ваша конфигурация застегнута и ранее опубликована в локальном репо:

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

Настройки

(См. Также документацию FindBugs)

findbugsReportType

• Описание: необязательно выбирает выходной формат для отчета FindBugs.
• Принимает: Some(FindbugsReportType.{Xml, Html, PlainHtml, FancyHtml, FancyHistHtml, Emacs, Xdoc})
• По умолчанию: Some(FindbugsReportType.Xml)

findbugsReportPath

• Описание: Целевой путь файла отчета для генерации (необязательно).
• Принимает: любой юридический путь
• По умолчанию: Some(crossTarget.value / "findbugs" / "report.xml")

findbugsPriority

• Описание: Подавить отчетность об ошибках на основе приоритета.
• Принимает: FindbugsPriority.{Relaxed, Low, Medium, High}
• По умолчанию: FindbugsPriority.Medium

findbugsEffort

• Описание: Решите, сколько усилий внести в анализ.
• Принимает: FindbugsEffort.{Minimum, Default, Maximum}
• По умолчанию: FindbugsEffort.Default

findbugsOnlyAnalyze

• Описание: Необязательно определить, какие пакеты/классы следует проанализировать.
• Принимает: опция, содержащая List[String] пакетов и классов.
• По умолчанию: None (значение: анализировать все).

findbugsMaxMemory

• Описание: Максимальное количество памяти, чтобы разрешить Findbugs (в MB).
• Принимает: любая разумная сумма памяти как целочисленное значение
• По умолчанию: 1024

findbugsAnalyzeNestedArchives

• Описание: должны ли Findbugs анализировать вложенные архивы или нет.
• Принимает: true и false
• По умолчанию: true

findbugsSortReportByClassNames

• Описание: следует ли отсортировать экземпляры ошибки по имени класса или нет.
• Принимает: true и false
• По умолчанию: false

findbugsIncludeFilters

• Описание: Необязательный файл фильтра XML Содержание, определяющее, какие экземпляры ошибки должны включать в статический анализ.
• Принимает: None и Option[Node]
• По умолчанию: None (нет включать фильтры).

findbugsExcludeFilters

• Описание: Необязательный файл файла XML Содержание, определяющее, какие экземпляры ошибки исключить в статическом анализе.
• Принимает: None , а Some[Node]
• По умолчанию: None (не исключать фильтры).

findbugsAnalyzedPath

• Описание: Путь к классам, которые будут проанализированы.
• Принимает: любой sbt.Path
• По умолчанию: Seq(classDirectory in Compile value)

Участники

Спасибо @asflierl и @anishathalye за их вклад!

Лицензия

Copyright (c) Joachim Hofer & Apportors

Все права защищены.

Эта программа и сопровождающие материалы предоставляются в соответствии с условиями публичной лицензии Eclipse V1.0, которая сопровождает это распределение и доступна по адресу http://www.eclipse.org/legal/epl-v10.html