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

หรือเมื่อการกำหนดค่าของคุณถูกซิปและเผยแพร่ก่อนหน้านี้ไปยัง repo ท้องถิ่น:

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 สำหรับการมีส่วนร่วมของพวกเขา!

ใบอนุญาต

ลิขสิทธิ์ (c) Joachim Hofer & ผู้สนับสนุน

สงวนลิขสิทธิ์

โปรแกรมนี้และวัสดุประกอบมีให้ภายใต้ข้อกำหนดของ ใบอนุญาตสาธารณะ Eclipse v1.0 ซึ่งมาพร้อมกับการกระจายนี้และมีอยู่ที่ http://www.eclipse.org/legal/epl-v10.html