Only report warnings via the reporter (#326)

* Only report warnings via the reporter * Fix tests * Enable reports during compilation by default
scapegoat-scala · Mar 29, 2020 · 0e80c05 · 0e80c05
1 parent e947418
commit 0e80c05
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 18 deletions.
diff --git a/src/main/scala/com/sksamuel/scapegoat/Feedback.scala b/src/main/scala/com/sksamuel/scapegoat/Feedback.scala
@@ -56,17 +56,17 @@ class Feedback(
       inspection = inspection.getClass.getCanonicalName
     )
     warningsBuffer.append(warning)
+
     if (shouldPrint(warning)) {
-      println(s"[${warning.level.toString.toLowerCase}] $sourceFileNormalized:${warning.line}: $text")
-      println(s"          $explanation")
-      snippet.foreach(s => println(s"          $s"))
-      println()
-    }
+      val snippetText = snippet.fold("")("\n  " + _ + "\n")
+      val report = s"""|[scapegoat] $text
+                       |  $explanation$snippetText""".stripMargin
 
-    adjustedLevel match {
-      case Levels.Error   => reporter.error(pos, text)
-      case Levels.Warning => reporter.warning(pos, text)
-      case Levels.Info    => reporter.info(pos, text, force = false)
+      adjustedLevel match {
+        case Levels.Error   => reporter.error(pos, report)
+        case Levels.Warning => reporter.warning(pos, report)
+        case Levels.Info    => reporter.info(pos, report, force = false)
+      }
     }
   }
 

diff --git a/src/main/scala/com/sksamuel/scapegoat/plugin.scala b/src/main/scala/com/sksamuel/scapegoat/plugin.scala
@@ -158,7 +158,7 @@ class ScapegoatComponent(val global: Global, inspections: Seq[Inspection])
   var disabledInspections: List[String] = Nil
   var enabledInspections: List[String] = Nil
   var ignoredFiles: List[String] = Nil
-  var consoleOutput: Boolean = false
+  var consoleOutput: Boolean = true
   var verbose: Boolean = false
   val debug: Boolean = false
   var summary: Boolean = true

diff --git a/src/test/scala/com/sksamuel/scapegoat/FeedbackTest.scala b/src/test/scala/com/sksamuel/scapegoat/FeedbackTest.scala
@@ -32,9 +32,11 @@ class FeedbackTest extends AnyFreeSpec with Matchers with OneInstancePerTest wit
           "This is explanation."
         )
         val reporter = new StoreReporter
-        val feedback = new Feedback(false, reporter, defaultSourcePrefix)
+        val feedback = new Feedback(true, reporter, defaultSourcePrefix)
         feedback.warn(position, inspection)
-        reporter.infos should contain(reporter.Info(position, "My default is Error", reporter.ERROR))
+        reporter.infos should contain(
+          reporter.Info(position, "[scapegoat] My default is Error\n  This is explanation.", reporter.ERROR)
+        )
       }
       "for warning" in {
         val inspection = new DummyInspection(
@@ -44,9 +46,12 @@ class FeedbackTest extends AnyFreeSpec with Matchers with OneInstancePerTest wit
           "This is explanation."
         )
         val reporter = new StoreReporter
-        val feedback = new Feedback(false, reporter, defaultSourcePrefix)
+        val feedback = new Feedback(true, reporter, defaultSourcePrefix)
         feedback.warn(position, inspection)
-        reporter.infos should contain(reporter.Info(position, "My default is Warning", reporter.WARNING))
+        reporter.infos should contain(
+          reporter
+            .Info(position, "[scapegoat] My default is Warning\n  This is explanation.", reporter.WARNING)
+        )
       }
       "for info" in {
         val inspection = new DummyInspection(
@@ -56,9 +61,11 @@ class FeedbackTest extends AnyFreeSpec with Matchers with OneInstancePerTest wit
           "This is explanation."
         )
         val reporter = new StoreReporter
-        val feedback = new Feedback(false, reporter, defaultSourcePrefix)
+        val feedback = new Feedback(true, reporter, defaultSourcePrefix)
         feedback.warn(position, inspection)
-        reporter.infos should contain(reporter.Info(position, "My default is Info", reporter.INFO))
+        reporter.infos should contain(
+          reporter.Info(position, "[scapegoat] My default is Info\n  This is explanation.", reporter.INFO)
+        )
       }
     }
     "should use proper paths" - {
@@ -111,7 +118,7 @@ class FeedbackTest extends AnyFreeSpec with Matchers with OneInstancePerTest wit
         )
         val inspections = Seq(inspectionError, inspectionWarning, inspectionInfo)
         val reporter = new StoreReporter
-        val feedback = new Feedback(false, reporter, defaultSourcePrefix, Levels.Info)
+        val feedback = new Feedback(true, reporter, defaultSourcePrefix, Levels.Info)
         inspections.foreach(inspection => feedback.warn(position, inspection))
         feedback.warningsWithMinimalLevel.length should be(3)
       }

diff --git a/src/test/scala/com/sksamuel/scapegoat/inspections/collections/MapGetAndGetOrElseTest.scala b/src/test/scala/com/sksamuel/scapegoat/inspections/collections/MapGetAndGetOrElseTest.scala
@@ -1,10 +1,11 @@
 package com.sksamuel.scapegoat.inspections.collections
 
 import com.sksamuel.scapegoat.PluginRunner
+import org.scalatest.OneInstancePerTest
 import org.scalatest.freespec.AnyFreeSpec
 import org.scalatest.matchers.should.Matchers
 
-class MapGetAndGetOrElseTest extends AnyFreeSpec with Matchers with PluginRunner {
+class MapGetAndGetOrElseTest extends AnyFreeSpec with Matchers with PluginRunner with OneInstancePerTest {
 
   override val inspections = Seq(new MapGetAndGetOrElse)