Add Scalafmt, Scalafix and other small improvements

Author: sideeffffect

.github/workflows/ci.yml

@@ -23,6 +23,8 @@ jobs:
         with:
           java-version: "adopt@1.8"
       - uses: coursier/cache-action@v5
+      - name: Formatting
+        run: sbt lint
       - name: Unit tests
         run: sbt "++${{ matrix.scalaversion }}" "${{ env.PROJECT_NAME }}/test"
       - name: Test generate documentation

.scalafix.conf

@@ -0,0 +1,16 @@
+rules = [
+  ExplicitResultTypes
+  LeakingImplicitClassVal
+  NoAutoTupling
+  NoValInForComprehension
+  OrganizeImports
+  ProcedureSyntax
+  RemoveUnused
+]
+OrganizeImports {
+  # Allign with IntelliJ IDEA so that they don't fight each other
+  groupedImports = Merge
+}
+RemoveUnused {
+  imports = false // handled by OrganizeImports
+}

.scalafmt.conf

@@ -0,0 +1,7 @@
+version = "2.7.5"
+preset=Scala.js
+maxColumn = 100
+newlines.alwaysBeforeMultilineDef = false
+rewrite.rules = [AvoidInfix, PreferCurlyFors]
+docstrings.style = AsteriskSpace
+danglingParentheses.ctrlSite = false

build.sbt

@@ -1,50 +1,63 @@
-// shadow sbt-scalajs' crossProject and CrossType until Scala.js 1.0.0 is released
-import com.typesafe.tools.mima.core._
-import sbtcrossproject.{crossProject, CrossType}
+// shadow sbt-scalajs' crossProject until Scala.js 1.0.0 is released
+import sbtcrossproject.crossProject
 
 val previousVersion = "1.1.1"
 
-inThisBuild(Def.settings(
-  crossScalaVersions := Seq("2.12.13", "2.11.12", "2.13.4"),
-  scalaVersion := crossScalaVersions.value.head,
-  version := "1.1.2-SNAPSHOT",
-  organization := "org.portable-scala",
-
-  scalacOptions ++= Seq(
-    "-deprecation",
-    "-feature",
-    "-encoding",
-    "utf-8",
-    "-Xfatal-warnings",
-  ),
-
-  homepage := Some(url("https://github.com/portable-scala/portable-scala-reflect")),
-  licenses += ("BSD New",
-    url("https://github.com/portable-scala/portable-scala-reflect/blob/master/LICENSE")),
-  scmInfo := Some(ScmInfo(
-    url("https://github.com/portable-scala/portable-scala-reflect"),
-    "scm:git:git@github.com:portable-scala/portable-scala-reflect.git",
-    Some("scm:git:git@github.com:portable-scala/portable-scala-reflect.git"))),
-))
+inThisBuild(
+    Def.settings(
+        crossScalaVersions := Seq("2.13.4", "2.12.13", "2.11.12"),
+        scalaVersion := crossScalaVersions.value.head,
+        version := "1.1.2-SNAPSHOT",
+        organization := "org.portable-scala",
+        scalacOptions ++= Seq(
+            "-deprecation",
+            "-feature",
+            "-encoding",
+            "utf-8",
+            "-Ywarn-unused"
+        ) ++ {
+          if (sys.env.contains("CI")) {
+            List("-Xfatal-warnings")
+          } else {
+            List() // to enable Scalafix locally
+          }
+        },
+        semanticdbEnabled := true,
+        semanticdbOptions += "-P:semanticdb:synthetics:on",
+        semanticdbVersion := scalafixSemanticdb.revision,
+        ThisBuild / scalafixScalaBinaryVersion := CrossVersion
+          .binaryScalaVersion(scalaVersion.value),
+        ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports" % "0.5.0",
+        libraryDependencies ++= List(
+            ("com.github.ghik" % "silencer-lib" % "1.7.3" % Provided).cross(CrossVersion.full),
+            compilerPlugin(
+                ("com.github.ghik" % "silencer-plugin" % "1.7.3").cross(CrossVersion.full)
+            )
+        ),
+        homepage := Some(url("https://github.com/portable-scala/portable-scala-reflect")),
+        licenses += ("BSD New",
+        url("https://github.com/portable-scala/portable-scala-reflect/blob/master/LICENSE")),
+        scmInfo := Some(ScmInfo(url("https://github.com/portable-scala/portable-scala-reflect"),
+                "scm:git:git@github.com:portable-scala/portable-scala-reflect.git",
+                Some("scm:git:git@github.com:portable-scala/portable-scala-reflect.git")))
+    ))
 
 lazy val `portable-scala-reflect` = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("."))
   .settings(
-    scalacOptions in (Compile, doc) -= "-Xfatal-warnings",
-
-    mimaPreviousArtifacts +=
-      organization.value %%% moduleName.value % previousVersion,
-
-    publishMavenStyle := true,
-    publishTo := {
-      val nexus = "https://oss.sonatype.org/"
-      if (isSnapshot.value)
-        Some("snapshots" at nexus + "content/repositories/snapshots")
-      else
-        Some("releases" at nexus + "service/local/staging/deploy/maven2")
-    },
-    pomExtra := (
-      <developers>
+      scalacOptions in (Compile, doc) -= "-Xfatal-warnings",
+      mimaPreviousArtifacts +=
+        organization.value %%% moduleName.value % previousVersion,
+      publishMavenStyle := true,
+      publishTo := {
+        val nexus = "https://oss.sonatype.org/"
+        if (isSnapshot.value)
+          Some("snapshots".at(nexus + "content/repositories/snapshots"))
+        else
+          Some("releases".at(nexus + "service/local/staging/deploy/maven2"))
+      },
+      pomExtra := (
+          <developers>
         <developer>
           <id>sjrd</id>
           <name>Sébastien Doeraene</name>
@@ -61,22 +74,28 @@ lazy val `portable-scala-reflect` = crossProject(JSPlatform, JVMPlatform, Native
           <url>https://github.com/densh/</url>
         </developer>
       </developers>
-    ),
-    pomIncludeRepository := { _ => false },
+      ),
+      pomIncludeRepository := { _ => false }
   )
   .jvmSettings(
-    // Macros
-    libraryDependencies += scalaOrganization.value % "scala-reflect" % scalaVersion.value % Provided,
-
-    // Speed up compilation a bit. Our .java files do not need to see the .scala files.
-    compileOrder := CompileOrder.JavaThenScala,
-
-    libraryDependencies += "com.novocode" % "junit-interface" % "0.11" % "test",
+      // Macros
+      libraryDependencies += scalaOrganization.value % "scala-reflect" % scalaVersion.value % Provided,
+      // Speed up compilation a bit. Our .java files do not need to see the .scala files.
+      compileOrder := CompileOrder.JavaThenScala,
+      libraryDependencies += "com.novocode" % "junit-interface" % "0.11" % "test"
   )
   .jsConfigure(_.enablePlugins(ScalaJSJUnitPlugin))
   .nativeSettings(
-    libraryDependencies +=
-      "org.scala-native" %%% "junit-runtime" % "0.4.0" % "test",
-    addCompilerPlugin(
-      "org.scala-native" % "junit-plugin" % "0.4.0" cross CrossVersion.full),
+      libraryDependencies +=
+        "org.scala-native" %%% "junit-runtime" % "0.4.0" % "test",
+      addCompilerPlugin(("org.scala-native" % "junit-plugin" % "0.4.0").cross(CrossVersion.full))
   )
+
+addCommandAlias(
+    "fix",
+    "; all compile:scalafix test:scalafix; all scalafmtSbt scalafmtAll"
+)
+addCommandAlias(
+    "lint",
+    "; scalafmtSbtCheck; scalafmtCheckAll; compile:scalafix --check; test:scalafix --check"
+)

js/src/main/scala/org/portablescala/reflect/Reflect.scala

@@ -1,8 +1,11 @@
 package org.portablescala.reflect
 
+import com.github.ghik.silencer.silent
+
 import scala.scalajs.reflect.{Reflect => SJSReflect}
 
 object Reflect {
+
   /** Reflectively looks up a loadable module class.
    *
    *  A module class is the technical term referring to the class of a Scala
@@ -34,10 +37,10 @@ object Reflect {
    *    Fully-qualified name of the module class, including its trailing `$`
    *
    *  @param loader
-   *    Ignored
+   *    Ignored, used in the JVM variant and we need to keep the API
    */
   def lookupLoadableModuleClass(fqcn: String,
-      loader: ClassLoader): Option[LoadableModuleClass] = {
+      @silent("never used") loader: ClassLoader): Option[LoadableModuleClass] = {
     lookupLoadableModuleClass(fqcn)
   }
 
@@ -72,10 +75,10 @@ object Reflect {
    *    Fully-qualified name of the class
    *
    *  @param loader
-   *    Ignored
+   *    Ignored, used in the JVM variant and we need to keep the API
    */
   def lookupInstantiatableClass(fqcn: String,
-      loader: ClassLoader): Option[InstantiatableClass] = {
+      @silent("never used") loader: ClassLoader): Option[InstantiatableClass] = {
     lookupInstantiatableClass(fqcn)
   }
 }

jvm/src/main/scala/org/portablescala/reflect/InstantiatableClass.scala

@@ -8,6 +8,7 @@ import java.lang.reflect.InvocationTargetException
  *    The `java.lang.Class[_]` representing the class.
  */
 final class InstantiatableClass private[reflect] (val runtimeClass: Class[_]) {
+
   /** A list of the public constructors declared in this class. */
   val declaredConstructors: List[InvokableConstructor] =
     runtimeClass.getConstructors().map(new InvokableConstructor(_)).toList
@@ -42,8 +43,7 @@ final class InstantiatableClass private[reflect] (val runtimeClass: Class[_]) {
    */
   def getConstructor(parameterTypes: Class[_]*): Option[InvokableConstructor] = {
     try {
-      Some(new InvokableConstructor(
-          runtimeClass.getConstructor(parameterTypes: _*)))
+      Some(new InvokableConstructor(runtimeClass.getConstructor(parameterTypes: _*)))
     } catch {
       case _: NoSuchMethodException => None
     }

jvm/src/main/scala/org/portablescala/reflect/InvokableConstructor.scala

@@ -4,6 +4,7 @@ import java.lang.reflect.Constructor
 
 /** A description of a constructor that can reflectively invoked. */
 final class InvokableConstructor private[reflect] (ctor: Constructor[_]) {
+
   /** The `Class[_]` objects representing the formal parameters of this
    *  constructor.
    */

jvm/src/main/scala/org/portablescala/reflect/LoadableModuleClass.scala

@@ -6,6 +6,7 @@ package org.portablescala.reflect
  *    The `java.lang.Class[_]` representing the module class.
  */
 final class LoadableModuleClass private[reflect] (val runtimeClass: Class[_]) {
+
   /** Loads the module instance and returns it.
    *
    *  If the underlying constructor throws an exception `e`, then `loadModule`

jvm/src/main/scala/org/portablescala/reflect/Reflect.scala

@@ -1,11 +1,12 @@
 package org.portablescala.reflect
 
-import scala.language.experimental.macros
-import scala.collection.mutable
-import java.lang.reflect._
 import org.portablescala.reflect.annotation._
 import org.portablescala.reflect.internal.Macros
 
+import java.lang.reflect._
+import scala.collection.mutable
+import scala.language.experimental.macros
+
 object Reflect {
 
   /** Reflectively looks up a loadable module class using the current class
@@ -52,8 +53,7 @@ object Reflect {
    *  @param loader
    *    Class loader to use to load the module class
    */
-  def lookupLoadableModuleClass(fqcn: String,
-      loader: ClassLoader): Option[LoadableModuleClass] = {
+  def lookupLoadableModuleClass(fqcn: String, loader: ClassLoader): Option[LoadableModuleClass] = {
     load(fqcn, loader).filter(isModuleClass).map(new LoadableModuleClass(_))
   }
 
@@ -101,8 +101,7 @@ object Reflect {
    *  @param loader
    *    Class loader to use to load the class
    */
-  def lookupInstantiatableClass(fqcn: String,
-      loader: ClassLoader): Option[InstantiatableClass] = {
+  def lookupInstantiatableClass(fqcn: String, loader: ClassLoader): Option[InstantiatableClass] = {
     load(fqcn, loader).filter(isInstantiatableClass).map(new InstantiatableClass(_))
   }
 

jvm/src/main/scala/org/portablescala/reflect/internal/Macros.scala

@@ -1,5 +1,6 @@
 package org.portablescala.reflect.internal
 
+import com.github.ghik.silencer.silent
 import org.portablescala.reflect._
 
 /* Macro definitions are enclosed in a dedicated `Macros` object,
@@ -9,9 +10,11 @@ import org.portablescala.reflect._
  * https://github.com/xeno-by/sbt-example-paradise210/issues/1#issuecomment-20996354
  */
 object Macros {
+
   /** Magic to get cross-compiling access to `blackbox.Context` with a fallback
    *  on `macros.Context`, without deprecation warning in any Scala version.
    */
+  @silent("Unused import")
   private object MacroCompat {
     object Scope1 {
       object blackbox
@@ -41,8 +44,7 @@ object Macros {
     }
   }
 
-  def lookupLoadableModuleClass(
-      c: BlackboxContext { type PrefixType = Reflect.type })(
+  def lookupLoadableModuleClass(c: BlackboxContext { type PrefixType = Reflect.type })(
       fqcn: c.Expr[String]): c.Expr[Option[LoadableModuleClass]] = {
     import c.universe._
     val loaderExpr = currentClassLoaderExpr(c)
@@ -51,8 +53,7 @@ object Macros {
     }
   }
 
-  def lookupInstantiatableClass(
-      c: BlackboxContext { type PrefixType = Reflect.type })(
+  def lookupInstantiatableClass(c: BlackboxContext { type PrefixType = Reflect.type })(
       fqcn: c.Expr[String]): c.Expr[Option[InstantiatableClass]] = {
     import c.universe._
     val loaderExpr = currentClassLoaderExpr(c)