Allow defining fatal warnings with sbt settings

Author: kciesielski

plugin-sbt/src/main/scala/com/softwaremill/clippy/ClippySbtPlugin.scala

@@ -43,6 +43,8 @@ object ClippySbtPlugin extends AutoPlugin {
       settingKey[Option[String]]("Directory where cached advice data should be stored, if other than default")
     val clippyProjectRoot =
       settingKey[Option[String]]("Project root in which project-specific advice is stored, if any")
+    val clippyFatalWarnings =
+      settingKey[List[String]]("Regular expressions of warning messages which should fail compilation")
   }
 
   // in ~/.sbt auto import doesn't work, so providing aliases here for convenience
@@ -56,6 +58,7 @@ object ClippySbtPlugin extends AutoPlugin {
   val clippyUrl           = autoImport.clippyUrl
   val clippyLocalStoreDir = autoImport.clippyLocalStoreDir
   val clippyProjectRoot   = autoImport.clippyProjectRoot
+  val clippyFatalWarnings = autoImport.clippyFatalWarnings
 
   override def projectSettings = Seq(
     clippyColorsEnabled := false,
@@ -68,6 +71,7 @@ object ClippySbtPlugin extends AutoPlugin {
     clippyUrl := None,
     clippyLocalStoreDir := None,
     clippyProjectRoot := None,
+    clippyFatalWarnings := Nil,
     addCompilerPlugin("com.softwaremill.clippy" %% "plugin" % ClippyBuildInfo.version classifier "bundle"),
     scalacOptions := {
       val result = ListBuffer(scalacOptions.value: _*)
@@ -81,6 +85,8 @@ object ClippySbtPlugin extends AutoPlugin {
       clippyUrl.value.foreach(c => result += s"-P:clippy:url=$c")
       clippyLocalStoreDir.value.foreach(c => result += s"-P:clippy:store=$c")
       clippyProjectRoot.value.foreach(c => result += s"-P:clippy:projectRoot=$c")
+      if (clippyFatalWarnings.value.nonEmpty)
+        result += s"-P:clippy:fatalWarnings=${clippyFatalWarnings.value.mkString("|")}"
       result.toList
     }
   )

plugin/src/main/scala/com/softwaremill/clippy/ClippyPlugin.scala

@@ -28,12 +28,13 @@ class ClippyPlugin(val global: Global) extends Plugin {
 
   override val description: String = "gives good advice"
 
-  var url: String                = ""
-  var colorsConfig: ColorsConfig = ColorsConfig.Disabled
-  var testMode                   = false
-  val DefaultStoreDir            = new File(System.getProperty("user.home"), ".clippy")
-  var localStoreDir              = DefaultStoreDir
-  var projectRoot: Option[File]  = None
+  var url: String                         = ""
+  var colorsConfig: ColorsConfig          = ColorsConfig.Disabled
+  var testMode                            = false
+  val DefaultStoreDir                     = new File(System.getProperty("user.home"), ".clippy")
+  var localStoreDir                       = DefaultStoreDir
+  var projectRoot: Option[File]           = None
+  var initialFatalWarnings: List[Warning] = Nil
 
   lazy val localAdviceFiles = {
     val classPathURLs = new PathResolver(global.settings).result.asURLs
@@ -72,7 +73,7 @@ class ClippyPlugin(val global: Global) extends Plugin {
     testMode = testModeFromOptions(options)
     localStoreDir = localStoreDirFromOptions(options)
     projectRoot = projectRootFromOptions(options)
-
+    initialFatalWarnings = initialFatalWarningsFromOptions(options)
     if (testMode) {
       val r = global.reporter
       global.reporter = new FailOnWarningsReporter(
@@ -177,6 +178,15 @@ class ClippyPlugin(val global: Global) extends Plugin {
       .map(new File(_, ".clippy.json"))
       .filter(_.exists())
 
+  private def initialFatalWarningsFromOptions(options: List[String]): List[Warning] =
+    options
+      .find(_.startsWith("fatalWarnings="))
+      .map(_.substring(14))
+      .map { str =>
+        str.split('|').toList.map(str => Warning(RegexT(str), text = None))
+      }
+      .getOrElse(Nil)
+
   private def localStoreDirFromOptions(options: List[String]): File =
     options.find(_.startsWith("store=")).map(_.substring(6)).map(new File(_)).getOrElse(DefaultStoreDir)
 
@@ -194,7 +204,7 @@ class ClippyPlugin(val global: Global) extends Plugin {
           new AdviceLoader(global, url, localStoreDir, projectAdviceFile, localAdviceFiles).load(),
           10.seconds
         )
-      AdvicesAndWarnings(clippyData.advices, clippyData.fatalWarnings)
+      AdvicesAndWarnings(clippyData.advices, clippyData.fatalWarnings ++ initialFatalWarnings)
     } catch {
       case e: TimeoutException =>
         global.warning(s"Unable to read advices from $url and store to $localStoreDir within 10 seconds.")