Make Compile Fail on Non-Exhaustive Match in SBT

Question

Let's say that I have a trait, Parent, with one child, Child.

scala> sealed trait Parent
defined trait Parent

scala> case object Boy extends Parent
defined module Boy

I write a function that pattern matches on the sealed trait. My f function is total since there's only a single Parent instance.

scala> def f(p: Parent): Boolean = p match { 
     |   case Boy => true
     | }
f: (p: Parent)Boolean

Then, 2 months later, I decide to add a Girl child of Parent.

scala> case object Girl extends Parent
defined module Girl

And then re-write the f method since we're using REPL.

scala> def f(p: Parent): Boolean = p match { 
     |   case Boy => true
     | }
<console>:10: warning: match may not be exhaustive.
It would fail on the following input: Girl
       def f(p: Parent): Boolean = p match { 
                                   ^
f: (p: Parent)Boolean

If I were to encounter a non-exhaustive match, then I'd get a compile-time warning (as we see here).

However, how can I make the compilation fail on a non-exhaustive match?

score 13 · Accepted Answer · edited Apr 26 '15 at 13:30

13

You can add -Xfatal-warnings to Scalac's options. That way any warning will be treated as an error.

In sbt, you can achieve that with:

scalacOptions += "-Xfatal-warnings"

edited Apr 26 '15 at 13:30

Jacek Laskowski

72,696
27
242
420

answered Feb 04 '15 at 17:16

Kim Stebel

41,826
12
125
142

16

This technically answers the question, but it's often not a viable solution. I'd personally be interested in seeing answers that don't require failing on all warnings, even if they're messier. – Travis Brown Feb 04 '15 at 17:20
@TravisBrown: Short of writing your own compiler plugin or SBT plugin, this is the only solution available. – Kim Stebel Feb 04 '15 at 23:17
@TravisBrown, why is it often not a "viable" solution? – Kevin Meredith Jul 13 '15 at 13:49
3

@KevinMeredith When you're working on a project that has lots of warnings that you don't care about. – Travis Brown Jul 13 '15 at 14:00
1

@Kim Stebel : old school but works: redirect the output to a file and look for the warning. In Jenkins you can make the build fail when it finds certain patterns in the log file. – Richard Gomes Nov 14 '16 at 12:21

score 7 · Answer 2 · answered Mar 14 '21 at 09:43

7

Since scalac 2.13.2 there's a fairly granular control of warnings. To get what OP asks:

scalacOptions += "-Wconf:cat=other-match-analysis:error"

Detailed howto by Lukas Rytz.

answered Mar 14 '21 at 09:43

Ales Kozumplik

71
1
1

Also the scala compiler option -Ypatmat-exhaust-depth can be useful, more info at https://docs.scala-lang.org/overviews/compiler-options/index.html – Carlos Saltos Jul 25 '21 at 18:41
Note: This was also backported to Scala 2.12.13+ – haukeh Nov 05 '21 at 13:03

score -7 · Answer 3 · answered Feb 04 '15 at 20:16

-7

Perhaps you could put in a default case to catch post-defined elements and bind it to a partial function which you can manage separately. Then the partial will act as a "default handler".

  sealed trait Animal
  case class Dog(name: String) extends Animal
  case class Cat(name: String) extends Animal

  val t: Animal = Dog("fido")

  // updates when the trait updates
  val partial = PartialFunction[Animal, Unit] {
    case Dog(_) => println("default dog")
    case Cat(_) => println("default cat")
    case _ => throw new RuntimeException("Broken")
  }

  // matches that may be out of date refer to it
  t match {
    case Dog(_) => println("specific dog")
    case t => partial(t)
  }

Or perhaps you can just use PartialFunctions all the way through and chain them together.

answered Feb 04 '15 at 20:16

Rich Henry

1,837
15
25

This solution brings a lot for boilerplate into codebase. Moreover, OP asks about SBT options to achieve this. – Andrii Abramov Oct 04 '18 at 08:07
1

Strange to comment so long after the question, but with 3 years of hindsight -- his problem is that he chose pattern matching in the first place. If he used something like a type class he could get the compiler failure he wants, and probably with less code. – Rich Henry Oct 04 '18 at 20:43
Sorry to comment again after such a long time. Could you extrapolate on the type class approach? I'm having a similar issue here. – Scarysize Sep 09 '20 at 11:45

Make Compile Fail on Non-Exhaustive Match in SBT

3 Answers3

Linked