Add scalafix

Author: mdedetrich

.github/workflows/test.yml

@@ -11,5 +11,7 @@ jobs:
       - uses: actions/[email protected]
         with:
           fetch-depth: 0
+      - name: 'Linter: Scalafix checks'
+        run: sbt "scalafixAll --check"
       - uses: olafurpg/setup-scala@v10
       - run: sbt test scripted publishLocal

.scalafix.conf

@@ -0,0 +1,30 @@
+rules = [
+  DisableSyntax, # Disables some constructs that make no semantic sense like `final val`
+  ProcedureSyntax, # Procedure syntax in Scala is always discouraged
+  NoValInForComprehension, # `val` in for comprehensions are deprecated and shouldn't be used
+  NoAutoTupling, # Avoids the automatic tupling in parameters
+  RemoveUnused, # Removes unused elements
+  LeakingImplicitClassVal, # This rule adds the private access modifier on the field of implicit value classes in order to prevent direct access.
+  OrganizeImports # Organizes imports and removes unused ones
+]
+
+ExplicitResultTypes.memberKind = [Def, Val, Var]
+ExplicitResultTypes.memberVisibility = [Public, Protected]
+ExplicitResultTypes.skipSimpleDefinitions = ['Lit', 'Term.New', 'Term.Ref']
+ExplicitResultTypes.fatalWarnings = true
+DisableSyntax.noReturns = true
+DisableSyntax.noWhileLoops = true
+DisableSyntax.noXml = true
+DisableSyntax.noFinalVal = true
+DisableSyntax.noFinalize = true
+DisableSyntax.noValPatterns = true
+RemoveUnused.imports = false # The plugin organize imports removes unused and clashes with this
+OrganizeImports {
+    groupedImports = Merge
+    groups = [
+        "*"
+        "java."
+        "scala."
+        "re:javax?\\."
+      ] # Reasoning for this config is to keep the more business related imports at the top, while language imports are on the bottom
+}

build.sbt

@@ -1,3 +1,5 @@
+import sbt.Keys.{semanticdbEnabled, semanticdbVersion}
+
 sbtPlugin := true
 
 organization := "net.bzzt"
@@ -41,3 +43,14 @@ scriptedLaunchOpts := {
     Seq("-Xmx1024M", "-Dplugin.version=" + version.value)
 }
 scriptedBufferLog := false
+
+// scalafix specific settings
+inThisBuild(
+  List(
+    semanticdbEnabled := true,
+    semanticdbVersion := scalafixSemanticdb.revision,
+    scalacOptions ++= Seq(
+      "-Ywarn-unused"
+    )
+  )
+)

project/plugins.sbt

@@ -5,3 +5,5 @@ addSbtPlugin("net.bzzt" % "sbt-reproducible-builds" % "0.30")
 addSbtPlugin("net.bzzt" % "sbt-strict-scala-versions" % "0.0.1")
 
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.0")
+
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.11.0")