pekko/project/AkkaDisciplinePlugin.scala
Arnout Engelen 8853175111 Don't apply 'discipline' flags to compilation run for documentation #26119
* Avoid -Ywarn-unused:_ on Scala 2.13
* Exclude warn-unused:explicits when generating docs
* Don't apply discipline to the docs compilation run

This approach also means no explicit code is needed anymore to
prevent #26119 from being triggered.
2019-03-01 13:39:08 +01:00

95 lines
2.9 KiB
Scala

/*
* Copyright (C) 2019 Lightbend Inc. <https://www.lightbend.com>
*/
package akka
import sbt._
import Keys.{scalacOptions, _}
import sbt.plugins.JvmPlugin
/**
* Initial tests found:
* `akka-actor` 151 errors with `-Xfatal-warnings`, 6 without the flag
*/
object AkkaDisciplinePlugin extends AutoPlugin with ScalafixSupport {
import scoverage.ScoverageKeys._
import scalafix.sbt.ScalafixPlugin
override def trigger: PluginTrigger = allRequirements
override def requires: Plugins = JvmPlugin && ScalafixPlugin
override lazy val projectSettings = disciplineSettings
lazy val scalaFixSettings = Seq(
Compile / scalacOptions += "-Yrangepos")
lazy val scoverageSettings = Seq(
coverageMinimum := 70,
coverageFailOnMinimum := false,
coverageOutputHTML := true,
coverageHighlighting := {
import sbt.librarymanagement.{ SemanticSelector, VersionNumber }
!VersionNumber(scalaVersion.value).matchesSemVer(SemanticSelector("<=2.11.1"))
})
lazy val disciplineSettings =
scalaFixSettings ++
scoverageSettings ++ Seq(
Compile / scalacOptions ++= disciplineScalacOptions,
Compile / scalacOptions --= undisciplineScalacOptions,
Compile / console / scalacOptions --= Seq("-deprecation", "-Xfatal-warnings", "-Xlint", "-Ywarn-unused:imports"),
// Discipline is not needed for the docs compilation run (which uses
// different compiler phases from the regular run), and in particular
// '-Ywarn-unused:explicits' breaks 'sbt ++2.13.0-M5 akka-actor/doc'
// https://github.com/akka/akka/issues/26119
Compile / doc / scalacOptions --= disciplineScalacOptions,
Compile / scalacOptions --= (CrossVersion.partialVersion(scalaVersion.value) match {
case Some((2, 13)) =>
Seq(
"-Ywarn-inaccessible",
"-Ywarn-infer-any",
"-Ywarn-nullary-override",
"-Ywarn-nullary-unit",
"-Ypartial-unification",
"-Yno-adapted-args",
)
case Some((2, 12)) =>
Nil
case Some((2, 11)) =>
Seq("-Ywarn-extra-implicit", "-Ywarn-unused:_")
case _ =>
Nil
}))
/**
* Remain visibly filtered for future code quality work and removing.
*/
val undisciplineScalacOptions = Seq(
"-Ywarn-value-discard",
"-Ywarn-numeric-widen",
"-Yno-adapted-args",
"-Xfatal-warnings")
/** These options are desired, but some are excluded for the time being*/
val disciplineScalacOptions = Seq(
// start: must currently remove, version regardless
"-Xfatal-warnings",
"-Ywarn-value-discard",
"-Yno-adapted-args",
"-Ywarn-numeric-widen",
// end
"-Xfuture",
"-Xlint",
"-Ywarn-dead-code",
"-Ywarn-inaccessible",
"-Ywarn-infer-any",
"-Ywarn-nullary-override",
"-Ywarn-nullary-unit",
"-Ywarn-unused:_",
"-Ypartial-unification",
"-Ywarn-extra-implicit",
"-Ywarn-numeric-widen")
}