feat: Support ignored files configuration on Scala 3 (#954)

Author: Johnnei

src/main/scala-3/com/sksamuel/scapegoat/Plugin.scala

@@ -28,12 +28,14 @@ class ScapegoatPlugin extends StandardPlugin {
 
 }
 
-class ScapegoatPhase(var configuration: Configuration, override val inspections: Seq[Inspection])
+class ScapegoatPhase(val configuration: Configuration, override val inspections: Seq[Inspection])
     extends PluginPhase
     with ScapegoatBasePlugin {
 
   private[scapegoat] var feedback: Option[FeedbackDotty] = None
 
+  private val ignorePatterns = configuration.ignoredFiles.map(_.r)
+
   override def phaseName: String = "scapegoat"
 
   override val runsAfter: Set[String] = Set(TyperPhase.name)
@@ -92,8 +94,11 @@ class ScapegoatPhase(var configuration: Configuration, override val inspections:
   }
 
   override def transformUnit(tree: tpd.Tree)(using ctx: Context): tpd.Tree = {
-    activeInspections.foreach { inspection =>
-      feedback.foreach(f => inspection.inspect(f, tree))
+    val sourcePath = ctx.compilationUnit.source.path
+    if (!ignorePatterns.exists(_.matches(sourcePath))) {
+      activeInspections.foreach { inspection =>
+        feedback.foreach(f => inspection.inspect(f, tree))
+      }
     }
     tree
   }

src/test/scala-3/com/sksamuel/scapegoat/DottyRunner.scala

@@ -59,6 +59,7 @@ class DottyRunner(
   val inspection: Class[? <: Inspection],
   reports: String                   = "none",
   disabledInspections: List[String] = List("none"),
+  ignoredFiles: List[String]        = List.empty,
   createDataDir: () => File         = DottyRunner.createTempDataDir
 ) extends Driver {
 
@@ -82,6 +83,7 @@ class DottyRunner(
         "-Xplugin-require:scapegoat",
         "-P:scapegoat:enabledInspections:" + inspection.getSimpleName,
         "-P:scapegoat:disabledInspections:" + disabledInspections.mkString(":"),
+        "-P:scapegoat:ignoredFiles:" + ignoredFiles.mkString(":"),
         "-P:scapegoat:verbose:true",
         s"-P:scapegoat:reports:$reports",
         s"-P:scapegoat:dataDir:${targetDir.getAbsolutePath}",

src/test/scala-3/com/sksamuel/scapegoat/ScapegoatPhaseTest.scala

@@ -14,6 +14,7 @@ class ScapegoatPhaseTest extends AnyFreeSpec with should.Matchers {
       classOf[OptionGet],
       report,
       if (disabledAll) List("all") else List("none"),
+      List.empty,
       () => targetFolder
     )
     val _ = dotty.compileCodeSnippet("class Test {}")
@@ -32,6 +33,28 @@ class ScapegoatPhaseTest extends AnyFreeSpec with should.Matchers {
       outputDir.listFiles(reportFilter) should contain theSameElementsAs (Array.empty[File])
     }
 
+    "ignore files" - {
+
+      def runDottyWithIgnore(patterns: List[String]) = {
+        val dotty = new DottyRunner(classOf[OptionGet], "html", List("none"), patterns)
+        dotty.compileCodeSnippet("""
+        class Test {
+          val o = Option("sammy")
+          o.get
+        }""".stripMargin)
+      }
+
+      "should report issue" in {
+        val feedback = runDottyWithIgnore(List.empty)
+        feedback.errors.size shouldBe 1
+      }
+
+      "should not report issue" in {
+        val feedback = runDottyWithIgnore(List(".*scapegoat_snippet.*\\.scala$"))
+        feedback.errors.size shouldBe 0
+      }
+    }
+
     "generate reports" - {
       "should generate html report" in {
         val outputDir = runDotty("html")