pimp my sbt

Author: sideeffffect

.scalafix.conf

@@ -0,0 +1,35 @@
+rules = [
+  RemoveUnused
+  ExplicitResultTypes
+  Disable
+]
+
+ExplicitResultTypes {
+  unsafeShortenNames = true
+}
+
+Disable.ifSynthetic = [
+  "java/io/Serializable"
+  "scala/Any"
+  ## "scala/Product" # triggers even on non-synthetic
+
+  # local type inference + covariant types fires this
+  # "scala/Nothing"
+
+  # when upstream broke noImplicitConversion and we don't agree that their
+  # implicits are worth the mental burden.
+  "scala/Option.option2Iterable"
+  "scala/Predef.any2stringadd"
+
+  # I don't understand why these are synthetic
+  # https://github.com/scalacenter/scalafix/issues/703
+  {
+    regex = {
+      includes = [
+        "^\\Qscala/collection/MapLike#apply().\\E$"
+        "^\\Qscala/collection/LinearSeqOptimized#apply().\\E$"
+      ]
+    }
+    message = "not a total function"
+  }
+]

.travis.yml

@@ -10,7 +10,7 @@ before_install:
 stages:
   - name: test
   - name: release
-    if: ((branch = master AND type = push) OR (tag IS present)) AND NOT fork
+    if: ((branch = master) OR (tag IS present)) AND NOT fork
 
 jobs:
   include:
@@ -19,7 +19,7 @@ jobs:
       script: sbt test
     -
       name: formatting
-      script: sbt scalafmtCheckAll
+      script: sbt check
     # run ci-release only if previous stages passed
     - stage: release
       script: sbt ci-release

build.sbt

@@ -1,27 +1,62 @@
+addCommandAlias("check", "; scalafmtSbtCheck; scalafmtCheckAll; compile:scalafix --check ; test:scalafix --check")
+addCommandAlias("fix", "; scalafmtSbt; scalafmtAll; compile:scalafix ; test:scalafix")
+
 ThisBuild / organization := "com.avast"
 ThisBuild / homepage := Some(url("https://github.com/avast/scala-server-toolkit"))
 ThisBuild / description := "Functional programming toolkit for building server applications in Scala."
 ThisBuild / licenses := Seq("MIT" -> url("https://raw.githubusercontent.com/avast/scala-server-toolkit/master/LICENSE"))
 ThisBuild / developers := List(Developer("jakubjanecek", "Jakub Janecek", "[email protected]", url("https://www.avast.com")))
-ThisBuild / scmInfo := Some(
-  ScmInfo(url("https://github.com/avast/scala-server-toolkit"), "scm:git:[email protected]:avast/scala-server-toolkit.git")
-)
 
 ThisBuild / scalaVersion := "2.13.0"
-ThisBuild / scalacOptions := ScalacOptions.default
 
 ThisBuild / turbo := true
 
 lazy val commonSettings = Seq(
   libraryDependencies ++= Seq(
     compilerPlugin(Dependencies.kindProjector),
+    compilerPlugin(Dependencies.betterMonadicFor),
+    compilerPlugin(Dependencies.silencer),
+    compilerPlugin(scalafixSemanticdb), // for scalafix
+    Dependencies.silencerLib,
     Dependencies.catsEffect,
-    Dependencies.scalaTest
+    Dependencies.scalaTest % Test
+  ),
+  Compile / compile / wartremoverErrors ++= Warts.all filterNot Set(
+    Wart.Nothing, // keep, false positives all around
+    Wart.Overloading,
+    Wart.Any, // keep, false positives all around
+    Wart.Equals, // keep, easier that way
+    Wart.ToString, // keep, easier that way
+    Wart.Product, // keep, false positives all around
+    Wart.Serializable // keep, false positives all around
   ),
-  Test / publishArtifact := false
+  ThisBuild / scalafixDependencies ++= Seq(
+    Dependencies.scalazzi // https://github.com/scalaz/scalazzi
+  ),
+  scalacOptions ++= Seq(
+    "-Yrangepos", // for scalafix. required by SemanticDB compiler plugin
+    "-Ywarn-unused", // for scalafix. not present in sbt-tpolecat for 2.13
+    "-P:silencer:checkUnused"
+  ),
+  scalacOptions --= {
+    if (!sys.env.contains("TRAVIS"))
+      Seq(
+        "-Xfatal-warnings" // for scala-fix https://scalacenter.github.io/scalafix/docs/rules/RemoveUnused.html
+      )
+    else
+      Seq()
+  },
+  Test / publishArtifact := false,
+  Test / test / wartremoverErrors := (Compile / compile / wartremoverErrors).value filterNot Set(
+    Wart.MutableDataStructures,
+    Wart.OptionPartial,
+    Wart.AsInstanceOf,
+    Wart.EitherProjectionPartial
+  )
 )
 
-lazy val root = (project in file("."))
+lazy val root = project
+  .in(file("."))
   .aggregate(example, pureconfig)
   .settings(
     name := "scala-server-toolkit",
@@ -31,8 +66,8 @@ lazy val root = (project in file("."))
 lazy val example = project
   .dependsOn(pureconfig)
   .enablePlugins(MdocPlugin)
+  .settings(commonSettings)
   .settings(
-    commonSettings,
     name := "scala-server-toolkit-example",
     publish / skip := true,
     run / fork := true,
@@ -46,8 +81,8 @@ lazy val example = project
   )
 
 lazy val pureconfig = project
+  .settings(commonSettings)
   .settings(
-    commonSettings,
     name := "scala-server-toolkit-pureconfig",
     libraryDependencies += Dependencies.pureConfig
   )

example/src/main/scala/com/avast/server/toolkit/example/Main.scala

@@ -3,17 +3,19 @@ package com.avast.server.toolkit.example
 import cats.effect.Resource
 import com.avast.server.toolkit.example.config.Configuration
 import com.avast.server.toolkit.pureconfig.PureConfigModule
+import com.github.ghik.silencer.silent
 import zio.interop.catz._
 import zio.{Task, ZIO}
 
 object Main extends CatsApp {
 
   def program: Resource[Task, Unit] = {
     for {
-      configuration <- Resource.liftF(PureConfigModule.makeOrRaise[Task, Configuration])
+      _ <- Resource.liftF(PureConfigModule.makeOrRaise[Task, Configuration])
     } yield ()
   }
 
+  @silent("dead code")
   override def run(args: List[String]): ZIO[Environment, Nothing, Int] = {
     program
       .use(_ => Task.never)

project/Dependencies.scala

@@ -2,11 +2,26 @@ import sbt._
 
 object Dependencies {
 
-  val catsEffect = "org.typelevel" %% "cats-effect" % "2.0.0"
-  val kindProjector = "org.typelevel" %% "kind-projector" % "0.10.3"
-  val pureConfig = "com.github.pureconfig" %% "pureconfig" % "0.12.0"
-  val scalaTest = "org.scalatest" %% "scalatest" % "3.0.8" % Test
-  val zio = "dev.zio" %% "zio" % "1.0.0-RC13"
-  val zioInteropCats = "dev.zio" %% "zio-interop-cats" % "2.0.0.0-RC4"
+  object Versions {
+    val catsEffect = "2.0.0"
+    val kindProjector = "0.10.3"
+    val pureConfig = "0.12.0"
+    val scalaTest = "3.0.8"
+    val zio = "1.0.0-RC13"
+    val zioInteropCats = "2.0.0.0-RC4"
+    val silencer = "1.4.3"
+    val scalazzi = "0.1.3"
+    val betterMonadicFor = "0.3.1"
+  }
 
+  val catsEffect = "org.typelevel" %% "cats-effect" % Versions.catsEffect
+  val kindProjector = "org.typelevel" %% "kind-projector" % Versions.kindProjector
+  val pureConfig = "com.github.pureconfig" %% "pureconfig" % Versions.pureConfig
+  val scalaTest = "org.scalatest" %% "scalatest" % Versions.scalaTest
+  val zio = "dev.zio" %% "zio" % Versions.zio
+  val zioInteropCats = "dev.zio" %% "zio-interop-cats" % Versions.zioInteropCats
+  val silencer = "com.github.ghik" % "silencer-plugin" % Versions.silencer cross CrossVersion.full
+  val silencerLib = "com.github.ghik" % "silencer-lib" % Versions.silencer cross CrossVersion.full
+  val scalazzi = "com.github.vovapolu" %% "scaluzzi" % Versions.scalazzi
+  val betterMonadicFor = "com.olegpy" %% "better-monadic-for" % Versions.betterMonadicFor
 }

project/ScalacOptions.scala

@@ -3,3 +3,7 @@ addSbtPlugin("org.scalameta" % "sbt-mdoc" % "1.3.2")
 addSbtPlugin("com.geirsson" % "sbt-ci-release" % "1.4.31")
 addSbtPlugin("com.thoughtworks.sbt-api-mappings" % "sbt-api-mappings" % "3.0.0")
 addSbtPlugin("io.chrisdavenport" % "sbt-mima-version-check" % "0.1.2")
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.7")
+addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.4.3")
+addSbtPlugin("io.github.davidgregory084" % "sbt-tpolecat" % "0.1.8")
+addSbtPlugin("com.github.tkawachi" % "sbt-lock" % "0.6.1")

project/plugins.sbt

@@ -6,7 +6,6 @@ import cats.syntax.either._
 import pureconfig.error.{ConfigReaderFailure, ConfigReaderFailures, ConvertFailure}
 import pureconfig.{ConfigReader, ConfigSource}
 
-import scala.language.higherKinds
 import scala.reflect.ClassTag
 
 /** Provides loading of configuration into case class via PureConfig. */