-
Notifications
You must be signed in to change notification settings - Fork 0
/
ScalacOptsPlugin.scala
164 lines (143 loc) · 10.4 KB
/
ScalacOptsPlugin.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
package com.evolution.scalacopts
import sbt.Keys._
import sbt._
import scala.Ordering.Implicits._
import scala.util.Try
object ScalacOptsPlugin extends AutoPlugin {
override def trigger: PluginTrigger = allRequirements
// major is always 2 since this plugin currently works with Scala 2 only
final case class ScalaVersion(minor: Long, patch: Option[Long] = None)
object ScalaVersion {
def apply(minor: Int): ScalaVersion = ScalaVersion(minor.toLong, None)
def apply(minor: Int, patch: Int): ScalaVersion =
ScalaVersion(minor.toLong, Some(patch.toLong))
implicit val scalaVersionOrdering: Ordering[ScalaVersion] =
new Ordering[ScalaVersion] {
def compare(x: ScalaVersion, y: ScalaVersion): Int =
x.patch.flatMap(xp => y.patch.map(yp => (xp, yp))) match {
// We are only using patches in case they both defined, otherwise - compare only minors
case Some((xp, yp)) =>
Ordering[(Long, Long)].compare((x.minor, xp), (y.minor, yp))
case None => Ordering[Long].compare(x.minor, y.minor)
}
}
}
final case class ScalacOpt(
name: String,
sinceOpt: Option[ScalaVersion] = None,
untilOpt: Option[ScalaVersion] = None
) {
def until(until: ScalaVersion): ScalacOpt = copy(untilOpt = Some(until))
def since(since: ScalaVersion): ScalacOpt = copy(sinceOpt = Some(since))
}
implicit def intToScalaVersion(minor: Int): ScalaVersion = ScalaVersion(minor)
val scalacOptsAll = List(
ScalacOpt("-deprecation") until 13, // Emit warning and location for usages of deprecated APIs. Not really removed but deprecated in 2.13.
ScalacOpt("-explaintypes"), // Explain type errors in more detail.
ScalacOpt("-feature"), // Emit warning and location for usages of features that should be imported explicitly.
ScalacOpt("-language:existentials"), // Existential types (besides wildcard types) can be written and inferred
ScalacOpt("-language:experimental.macros"), // Allow macro definition (besides implementation and application)
ScalacOpt("-language:higherKinds"), // Allow higher-kinded types
ScalacOpt("-language:implicitConversions"), // Allow definition of implicit functions called views
ScalacOpt("-unchecked"), // Enable additional warnings where generated code depends on assumptions.
ScalacOpt("-Xcheckinit"), // Wrap field accessors to throw an exception on uninitialized access.
ScalacOpt("-Xfatal-warnings"), // Fail the compilation if there are any warnings.
ScalacOpt("-Xfuture") until 13, // Turn on future language features. This is not really removed in 2.13 but is replaced by -Xsource which requires the user to choose which language version they want.
ScalacOpt("-Xlog-reflective-calls"), // Print a message when a reflective method call is generated
ScalacOpt("-Xlint") until 11, // Used to mean enable all linting options but now the syntax for that is different (-Xlint:_ I think)
ScalacOpt("-Xlint:adapted-args"), // Warn if an argument list is modified to match the receiver.
ScalacOpt("-Xlint:by-name-right-associative") until 13, // By-name parameter of right associative operator.
ScalacOpt("-Xlint:constant") since 12, // Evaluation of a constant arithmetic expression results in an error.
ScalacOpt("-Xlint:delayedinit-select"), // Selecting member of DelayedInit.
ScalacOpt("-Xlint:deprecation") since 13, // Emit warning and location for usages of deprecated APIs.
ScalacOpt("-Xlint:doc-detached"), // A Scaladoc comment appears to be detached from its element.
ScalacOpt("-Xlint:inaccessible"), // Warn about inaccessible types in method signatures.
ScalacOpt("-Xlint:infer-any"), // Warn when a type argument is inferred to be `Any`.
ScalacOpt("-Xlint:missing-interpolator"), // A string literal appears to be missing an interpolator id.
ScalacOpt("-Xlint:nullary-override") until 13, // Warn when non-nullary `def f()' overrides nullary `def f'.
ScalacOpt("-Xlint:nullary-unit"), // Warn when nullary methods return Unit.
ScalacOpt("-Xlint:option-implicit"), // Option.apply used implicit view.
ScalacOpt("-Xlint:package-object-classes"), // Class or object defined in package object.
ScalacOpt("-Xlint:poly-implicit-overload"), // Parameterized overloaded implicit methods are not visible as view bounds.
ScalacOpt("-Xlint:private-shadow"), // A private field (or class parameter) shadows a superclass field.
ScalacOpt("-Xlint:stars-align"), // Pattern sequence wildcard must align with sequence component.
ScalacOpt("-Xlint:type-parameter-shadow"), // A local type parameter shadows a type already in scope.
ScalacOpt("-Xlint:unsound-match") until 13, // Pattern match may not be typesafe.
ScalacOpt("-Ywarn-macros:after"), // Enable lint warnings on macro expansions: Only inspect expanded trees when generating unused symbol warnings.
ScalacOpt("-Yno-adapted-args") until 13, // Do not adapt an argument list (either by inserting () or creating a tuple) to match the receiver.
ScalacOpt("-Ypartial-unification") until 13, // Enable partial unification in type constructor inference
ScalacOpt("-Ywarn-dead-code") until 13, // Warn when dead code is identified.
ScalacOpt("-Wdead-code") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-extra-implicit") since 12 until 13, // Warn when more than one implicit parameter section is defined.
ScalacOpt("-Wextra-implicit") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-inaccessible") until 11, // Warn about inaccessible types in method signatures. Alias for -Xlint:inaccessible so can be removed as of 2.11.
ScalacOpt("-Ywarn-nullary-override") until 13, // Warn when non-nullary `def f()' overrides nullary `def f'.
ScalacOpt("-Ywarn-nullary-unit") until 13, // Warn when nullary methods return Unit.
ScalacOpt("-Ywarn-numeric-widen") until 13, // Warn when numerics are widened.
ScalacOpt("-Wnumeric-widen") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-unused-import") until 12, // Warn if an import selector is not referenced.
ScalacOpt("-Ywarn-unused:implicits") since 12 until 13, // Warn if an implicit parameter is unused.
ScalacOpt("-Wunused:implicits") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-unused:imports") since 12 until 13, // Warn if an import selector is not referenced.
ScalacOpt("-Wunused:imports") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-unused:locals") since 12 until 13, // Warn if a local definition is unused.
ScalacOpt("-Wunused:locals") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-unused:params") since 12 until 13, // Warn if a value parameter is unused.
ScalacOpt("-Wunused:params") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-unused:patvars") since 12 until 13, // Warn if a variable bound in a pattern is unused.
ScalacOpt("-Wunused:patvars") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-unused:privates") since 12 until 13, // Warn if a private member is unused.
ScalacOpt("-Wunused:privates") since 13, // ^ Replaces the above
ScalacOpt("-Ywarn-value-discard") until 13, // Warn when non-Unit expression results are unused.
ScalacOpt("-Wvalue-discard") since 13, // ^ Replaces the above
ScalacOpt("-Wnonunit-statement") since ScalaVersion(13, 9), // Warn when expression is ignored because it is followed by another expression.
)
object autoImport {
lazy val scalacOptsFailOnWarn = settingKey[Option[Boolean]]("Adds or removes -Xfatal-warnings")
def scalacOptsFor(version: String, scalacOpts: List[ScalacOpt]): List[String] = {
// consider only major version 2 since this plugin currently works with Scala 2 only
val scalaVersion: Option[ScalaVersion] =
(CrossVersion.partialVersion(version), version.split('.')) match {
case (Some((2, minor)), Array(_, _, patch)) =>
Some(ScalaVersion(minor, Try(patch.toLong).toOption))
case (Some((2, minor)), _) => Some(ScalaVersion(minor, None))
case _ => None
}
val opts = for {
version <- scalaVersion.toList
scalacOpt <- scalacOpts
if scalacOpt.sinceOpt forall { _ <= version }
if scalacOpt.untilOpt forall { _ > version }
} yield {
scalacOpt.name
}
List("-encoding", "utf-8") ++ opts
}
val filterConsoleScalacOpts: Seq[String] => Seq[String] = {
val exclude = Set(
"-Werror",
"-Wdead-code",
"-Wunused:imports",
"-Ywarn-unused:imports",
"-Ywarn-unused-import",
"-Ywarn-dead-code",
"-Xfatal-warnings")
opts: Seq[String] => opts.filterNot(exclude)
}
def failOnWarn(failOnWarn: Option[Boolean]): Seq[String] => Seq[String] = {
val opt = "-Xfatal-warnings"
opts: Seq[String] =>
failOnWarn.fold(opts) {
case true => if (opts contains opt) opts else opts :+ opt
case false => opts.filter(_ != opt)
}
}
}
import autoImport._
override def projectSettings: Seq[Setting[_]] = List(
scalacOptsFailOnWarn := Some(true),
scalacOptions ++= failOnWarn(scalacOptsFailOnWarn.value)(scalacOptsFor(scalaVersion.value, scalacOptsAll)),
Compile / console / scalacOptions ~= filterConsoleScalacOpts,
Test / console / scalacOptions ~= filterConsoleScalacOpts
)
}