Add the relaxedMode & strictMode commands

README.md

@@ -27,6 +27,11 @@ By default the plugin only applies this filtering to the `console` task in the `
 scalacOptions.in(Tut) ~= filterConsoleScalacOptions
 ```
 
+Additionally, if you need to temporarily disable fatal warnings.
+You can do it by running the `relaxedMode` command.
+Then, you can enable them again by running the `strictMode` command.<br>
+You may also enable the relaxed mode by setting the `SBT_TPOLECAT_RELAXED` env var.
+
 ### Caveat
 
 I can't promise this plugin will work for old minor releases of Scala. It has been tested with:

src/main/scala/io/github/davidgregory084/TpolecatPlugin.scala

@@ -18,7 +18,7 @@ package io.github.davidgregory084
 
 import sbt._
 import sbt.Keys._
-import scala.util.Try
+import scala.util.{Properties, Try}
 
 object TpolecatPlugin extends AutoPlugin {
   override def trigger: PluginTrigger = allRequirements
@@ -128,27 +128,31 @@ object TpolecatPlugin extends AutoPlugin {
       addedPriorTo && notYetRemoved
     }
 
-    def scalacOptionsFor(version: String): Seq[String] =
-      List(
-        "-encoding", "utf8" // Specify character encoding used by source files.
-      ) ++ {
-
-        val flags = (CrossVersion.partialVersion(version), version.split('.')) match {
-          case (Some((0, min)), _) => // dotty prereleases use 0 as major version
-            allScalacOptions
-              .filter(validFor(V3_0_0)) // treat dotty prereleases as 3.0.0
-          case (Some((maj, min)), Array(maj2, min2, patch)) if maj.toString == maj2 && min.toString == min2 =>
-            allScalacOptions
-              .filter(validFor(Version(maj, min, Try(patch.toLong).getOrElse(0))))
-          case (Some((maj, min)), _) =>
-            allScalacOptions
-              .filter(validFor(Version(maj, min, 0)))
-          case (None, _) =>
-            Nil
-        }
-
-      flags.map(_.name)
-}
+    def scalacOptionsFor(version: String): Seq[String] = {
+      val flags = (CrossVersion.partialVersion(version), version.split('.')) match {
+        case (Some((0, min)), _) => // dotty prereleases use 0 as major version
+          allScalacOptions
+            .filter(validFor(V3_0_0)) // treat dotty prereleases as 3.0.0
+        case (Some((maj, min)), Array(maj2, min2, patch)) if maj.toString == maj2 && min.toString == min2 =>
+          allScalacOptions
+            .filter(validFor(Version(maj, min, Try(patch.toLong).getOrElse(0))))
+        case (Some((maj, min)), _) =>
+          allScalacOptions
+            .filter(validFor(Version(maj, min, 0)))
+        case (None, _) =>
+          Nil
+      }
+
+      // Specify character encoding used by source files.
+      val allFlags = "-encoding" :: "utf8" :: flags.map(_.name)
+
+      // Check if we are in relaxed mode.
+      val relaxed = Properties.envOrNone(name = "SBT_TPOLECAT_RELAXED")
+      relaxed.fold(ifEmpty = allFlags) { _ =>
+        allFlags.filterNot(Set("-Xfatal-warnings"))
+      }
+    }
+
     val filterConsoleScalacOptions = { options: Seq[String] =>
       options.filterNot(Set(
         "-Werror",
@@ -161,13 +165,40 @@ object TpolecatPlugin extends AutoPlugin {
         "-Xfatal-warnings"
       ))
     }
+
+    lazy val strictMode: Command = Command.command("strictMode") { state =>
+      val projectRef = Project.extract(state)
+
+      val actions = projectRef.structure.allProjectRefs.map { p =>
+        p / scalacOptions += "-Xfatal-warnings"
+      }
+
+      projectRef.appendWithSession(
+        actions,
+        state
+      )
+    }
+
+    lazy val relaxedMode: Command = Command.command("relaxedMode") { state =>
+      val projectRef = Project.extract(state)
+
+      val actions = projectRef.structure.allProjectRefs.map { p =>
+        p / scalacOptions -= "-Xfatal-warnings"
+      }
+
+      projectRef.appendWithSession(
+        actions,
+        state
+      )
+    }
   }
 
   import autoImport._
 
   override def projectSettings: Seq[Setting[_]] = Seq(
     scalacOptions ++= scalacOptionsFor(scalaVersion.value),
     Compile / console / scalacOptions ~= filterConsoleScalacOptions,
-    Test /  console / scalacOptions ~= filterConsoleScalacOptions
+    Test /  console / scalacOptions ~= filterConsoleScalacOptions,
+    commands ++= Seq(strictMode, relaxedMode)
   )
 }