Skip to content

Commit e00c90f

Browse files
sideeffffectsideeffffect
committed
Add Scalafmt, Scalafix and other small improvements
1 parent 6303234 commit e00c90f

File tree

13 files changed

+175
-149
lines changed

13 files changed

+175
-149
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ jobs:
2323
with:
2424
java-version: "adopt@1.8"
2525
- uses: coursier/cache-action@v5
26+
- name: Formatting
27+
run: sbt lint
2628
- name: Unit tests
2729
run: sbt "++${{ matrix.scalaversion }}" "${{ env.PROJECT_NAME }}/test"
2830
- name: Test generate documentation

‎.scalafix.conf‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
rules = [
2+
ExplicitResultTypes
3+
LeakingImplicitClassVal
4+
NoAutoTupling
5+
NoValInForComprehension
6+
OrganizeImports
7+
ProcedureSyntax
8+
RemoveUnused
9+
]
10+
OrganizeImports {
11+
# Allign with IntelliJ IDEA so that they don't fight each other
12+
groupedImports = Merge
13+
}
14+
RemoveUnused {
15+
imports = false // handled by OrganizeImports
16+
}

‎.scalafmt.conf‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version = "2.7.5"
2+
preset=Scala.js
3+
maxColumn = 100
4+
newlines.alwaysBeforeMultilineDef = false
5+
rewrite.rules = [AvoidInfix, PreferCurlyFors]
6+
docstrings.style = AsteriskSpace
7+
danglingParentheses.ctrlSite = false

‎build.sbt‎

Lines changed: 85 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,77 @@
1-
// shadow sbt-scalajs' crossProject and CrossType until Scala.js 1.0.0 is released
1+
// shadow sbt-scalajs' crossProject until Scala.js 1.0.0 is released
22
import com.typesafe.tools.mima.core._
3-
import sbtcrossproject.{crossProject, CrossType}
3+
import sbtcrossproject.crossProject
44

55
val previousVersion = "1.1.1"
66

7-
inThisBuild(Def.settings(
8-
crossScalaVersions := Seq("2.12.13", "2.11.12", "2.13.4"),
9-
scalaVersion := crossScalaVersions.value.head,
10-
version := "1.1.2-SNAPSHOT",
11-
organization := "org.portable-scala",
12-
13-
scalacOptions ++= Seq(
14-
"-deprecation",
15-
"-feature",
16-
"-encoding",
17-
"utf-8",
18-
"-Xfatal-warnings",
19-
),
20-
21-
homepage := Some(url("https://github.com/portable-scala/portable-scala-reflect")),
22-
licenses += ("BSD New",
23-
url("https://github.com/portable-scala/portable-scala-reflect/blob/master/LICENSE")),
24-
scmInfo := Some(ScmInfo(
25-
url("https://github.com/portable-scala/portable-scala-reflect"),
26-
"scm:git:git@github.com:portable-scala/portable-scala-reflect.git",
27-
Some("scm:git:git@github.com:portable-scala/portable-scala-reflect.git"))),
28-
))
7+
inThisBuild(
8+
Def.settings(
9+
crossScalaVersions := Seq("2.13.4", "2.12.13", "2.11.12"),
10+
scalaVersion := crossScalaVersions.value.head,
11+
version := "1.1.2-SNAPSHOT",
12+
organization := "org.portable-scala",
13+
scalacOptions ++= Seq(
14+
"-deprecation",
15+
"-feature",
16+
"-encoding",
17+
"utf-8",
18+
"-Ywarn-unused"
19+
) ++ {
20+
if (sys.env.contains("CI")) {
21+
List("-Xfatal-warnings")
22+
} else {
23+
List() // to enable Scalafix locally
24+
}
25+
},
26+
semanticdbEnabled := true,
27+
semanticdbOptions += "-P:semanticdb:synthetics:on",
28+
semanticdbVersion := scalafixSemanticdb.revision,
29+
ThisBuild / scalafixScalaBinaryVersion := CrossVersion
30+
.binaryScalaVersion(scalaVersion.value),
31+
ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports" % "0.5.0",
32+
libraryDependencies ++= List(
33+
("com.github.ghik" % "silencer-lib" % "1.7.3" % Provided).cross(CrossVersion.full),
34+
compilerPlugin(
35+
("com.github.ghik" % "silencer-plugin" % "1.7.3").cross(CrossVersion.full)
36+
)
37+
),
38+
homepage := Some(url("https://github.com/portable-scala/portable-scala-reflect")),
39+
licenses += ("BSD New",
40+
url("https://github.com/portable-scala/portable-scala-reflect/blob/master/LICENSE")),
41+
scmInfo := Some(ScmInfo(url("https://github.com/portable-scala/portable-scala-reflect"),
42+
"scm:git:git@github.com:portable-scala/portable-scala-reflect.git",
43+
Some("scm:git:git@github.com:portable-scala/portable-scala-reflect.git")))
44+
))
2945

3046
lazy val `portable-scala-reflect` = crossProject(JSPlatform, JVMPlatform, NativePlatform)
3147
.in(file("."))
3248
.settings(
33-
scalacOptions in (Compile, doc) -= "-Xfatal-warnings",
34-
35-
mimaPreviousArtifacts +=
36-
organization.value %%% moduleName.value % previousVersion,
37-
38-
publishMavenStyle := true,
39-
publishTo := {
40-
val nexus = "https://oss.sonatype.org/"
41-
if (isSnapshot.value)
42-
Some("snapshots" at nexus + "content/repositories/snapshots")
43-
else
44-
Some("releases" at nexus + "service/local/staging/deploy/maven2")
45-
},
46-
pomExtra := (
47-
<developers>
49+
scalacOptions in (Compile, doc) -= "-Xfatal-warnings",
50+
mimaPreviousArtifacts +=
51+
organization.value %%% moduleName.value % previousVersion,
52+
mimaBinaryIssueFilters ++= List(
53+
/* `MacroCompat` has been removed, it was needed for Scala 2.10 only */
54+
ProblemFilters.exclude[MissingClassProblem](
55+
"org.portablescala.reflect.internal.Macros$MacroCompat$"),
56+
ProblemFilters.exclude[MissingClassProblem](
57+
"org.portablescala.reflect.internal.Macros$MacroCompat$Scope1$"),
58+
ProblemFilters.exclude[MissingClassProblem](
59+
"org.portablescala.reflect.internal.Macros$MacroCompat$Scope2$"),
60+
ProblemFilters.exclude[MissingClassProblem](
61+
"org.portablescala.reflect.internal.Macros$MacroCompat$Scope2$Inner$"),
62+
ProblemFilters.exclude[MissingClassProblem](
63+
"org.portablescala.reflect.internal.Macros$MacroCompat$Scope1$blackbox$")
64+
),
65+
publishMavenStyle := true,
66+
publishTo := {
67+
val nexus = "https://oss.sonatype.org/"
68+
if (isSnapshot.value)
69+
Some("snapshots".at(nexus + "content/repositories/snapshots"))
70+
else
71+
Some("releases".at(nexus + "service/local/staging/deploy/maven2"))
72+
},
73+
pomExtra := (
74+
<developers>
4875
<developer>
4976
<id>sjrd</id>
5077
<name>Sébastien Doeraene</name>
@@ -61,22 +88,28 @@ lazy val `portable-scala-reflect` = crossProject(JSPlatform, JVMPlatform, Native
6188
<url>https://github.com/densh/</url>
6289
</developer>
6390
</developers>
64-
),
65-
pomIncludeRepository := { _ => false },
91+
),
92+
pomIncludeRepository := { _ => false }
6693
)
6794
.jvmSettings(
68-
// Macros
69-
libraryDependencies += scalaOrganization.value % "scala-reflect" % scalaVersion.value % Provided,
70-
71-
// Speed up compilation a bit. Our .java files do not need to see the .scala files.
72-
compileOrder := CompileOrder.JavaThenScala,
73-
74-
libraryDependencies += "com.novocode" % "junit-interface" % "0.11" % "test",
95+
// Macros
96+
libraryDependencies += scalaOrganization.value % "scala-reflect" % scalaVersion.value % Provided,
97+
// Speed up compilation a bit. Our .java files do not need to see the .scala files.
98+
compileOrder := CompileOrder.JavaThenScala,
99+
libraryDependencies += "com.novocode" % "junit-interface" % "0.11" % "test"
75100
)
76101
.jsConfigure(_.enablePlugins(ScalaJSJUnitPlugin))
77102
.nativeSettings(
78-
libraryDependencies +=
79-
"org.scala-native" %%% "junit-runtime" % "0.4.0" % "test",
80-
addCompilerPlugin(
81-
"org.scala-native" % "junit-plugin" % "0.4.0" cross CrossVersion.full),
103+
libraryDependencies +=
104+
"org.scala-native" %%% "junit-runtime" % "0.4.0" % "test",
105+
addCompilerPlugin(("org.scala-native" % "junit-plugin" % "0.4.0").cross(CrossVersion.full))
82106
)
107+
108+
addCommandAlias(
109+
"fix",
110+
"; all compile:scalafix test:scalafix; all scalafmtSbt scalafmtAll"
111+
)
112+
addCommandAlias(
113+
"lint",
114+
"; scalafmtSbtCheck; scalafmtCheckAll; compile:scalafix --check; test:scalafix --check"
115+
)

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
package org.portablescala.reflect
22

3+
import com.github.ghik.silencer.silent
4+
35
import scala.scalajs.reflect.{Reflect => SJSReflect}
46

57
object Reflect {
8+
69
/** Reflectively looks up a loadable module class.
710
*
811
* A module class is the technical term referring to the class of a Scala
@@ -34,10 +37,10 @@ object Reflect {
3437
* Fully-qualified name of the module class, including its trailing `$`
3538
*
3639
* @param loader
37-
* Ignored
40+
* Ignored, used in the JVM variant and we need to keep the API
3841
*/
3942
def lookupLoadableModuleClass(fqcn: String,
40-
loader: ClassLoader): Option[LoadableModuleClass] = {
43+
@silent("never used") loader: ClassLoader): Option[LoadableModuleClass] = {
4144
lookupLoadableModuleClass(fqcn)
4245
}
4346

@@ -72,10 +75,10 @@ object Reflect {
7275
* Fully-qualified name of the class
7376
*
7477
* @param loader
75-
* Ignored
78+
* Ignored, used in the JVM variant and we need to keep the API
7679
*/
7780
def lookupInstantiatableClass(fqcn: String,
78-
loader: ClassLoader): Option[InstantiatableClass] = {
81+
@silent("never used") loader: ClassLoader): Option[InstantiatableClass] = {
7982
lookupInstantiatableClass(fqcn)
8083
}
8184
}

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ import java.lang.reflect.InvocationTargetException
88
* The `java.lang.Class[_]` representing the class.
99
*/
1010
final class InstantiatableClass private[reflect] (val runtimeClass: Class[_]) {
11+
1112
/** A list of the public constructors declared in this class. */
1213
val declaredConstructors: List[InvokableConstructor] =
13-
runtimeClass.getConstructors().map(new InvokableConstructor(_)).toList
14+
runtimeClass.getConstructors.map(new InvokableConstructor(_)).toList
1415

1516
/** Instantiates this class using its zero-argument constructor.
1617
*
@@ -26,12 +27,6 @@ final class InstantiatableClass private[reflect] (val runtimeClass: Class[_]) {
2627
throw e.getCause
2728
case e: NoSuchMethodException =>
2829
throw new InstantiationException(runtimeClass.getName).initCause(e)
29-
case _: IllegalAccessException =>
30-
/* The constructor exists but is private; make it look like it does not
31-
* exist at all.
32-
*/
33-
throw new InstantiationException(runtimeClass.getName).initCause(
34-
new NoSuchMethodException(runtimeClass.getName + ".<init>()"))
3530
}
3631
}
3732

@@ -42,8 +37,7 @@ final class InstantiatableClass private[reflect] (val runtimeClass: Class[_]) {
4237
*/
4338
def getConstructor(parameterTypes: Class[_]*): Option[InvokableConstructor] = {
4439
try {
45-
Some(new InvokableConstructor(
46-
runtimeClass.getConstructor(parameterTypes: _*)))
40+
Some(new InvokableConstructor(runtimeClass.getConstructor(parameterTypes: _*)))
4741
} catch {
4842
case _: NoSuchMethodException => None
4943
}

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

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
package org.portablescala.reflect
22

3-
import java.lang.reflect.Constructor
3+
import java.lang.reflect._
44

55
/** A description of a constructor that can reflectively invoked. */
66
final class InvokableConstructor private[reflect] (ctor: Constructor[_]) {
7+
78
/** The `Class[_]` objects representing the formal parameters of this
89
* constructor.
910
*/
10-
val parameterTypes: List[Class[_]] = ctor.getParameterTypes().toList
11+
val parameterTypes: List[Class[_]] = ctor.getParameterTypes.toList
1112

1213
/** Invokes this constructor to instantiate a new object.
1314
*
@@ -22,12 +23,8 @@ final class InvokableConstructor private[reflect] (ctor: Constructor[_]) {
2223
try {
2324
ctor.newInstance(args.asInstanceOf[Seq[AnyRef]]: _*)
2425
} catch {
25-
case e: java.lang.reflect.InvocationTargetException =>
26-
val cause = e.getCause
27-
if (cause == null)
28-
throw e
29-
else
30-
throw cause
26+
case e: InvocationTargetException if e.getCause != null =>
27+
throw e.getCause
3128
}
3229
}
3330
}

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ package org.portablescala.reflect
66
* The `java.lang.Class[_]` representing the module class.
77
*/
88
final class LoadableModuleClass private[reflect] (val runtimeClass: Class[_]) {
9+
910
/** Loads the module instance and returns it.
1011
*
1112
* If the underlying constructor throws an exception `e`, then `loadModule`
@@ -16,12 +17,8 @@ final class LoadableModuleClass private[reflect] (val runtimeClass: Class[_]) {
1617
try {
1718
runtimeClass.getField("MODULE$").get(null)
1819
} catch {
19-
case e: java.lang.ExceptionInInitializerError =>
20-
val cause = e.getCause
21-
if (cause == null)
22-
throw e
23-
else
24-
throw cause
20+
case e: ExceptionInInitializerError if e.getCause != null =>
21+
throw e.getCause
2522
}
2623
}
2724
}

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
package org.portablescala.reflect
22

3-
import scala.language.experimental.macros
4-
import scala.collection.mutable
5-
import java.lang.reflect._
63
import org.portablescala.reflect.annotation._
74
import org.portablescala.reflect.internal.Macros
85

6+
import java.lang.reflect._
7+
import scala.collection.mutable
8+
import scala.language.experimental.macros
9+
910
object Reflect {
1011

1112
/** Reflectively looks up a loadable module class using the current class
@@ -52,8 +53,7 @@ object Reflect {
5253
* @param loader
5354
* Class loader to use to load the module class
5455
*/
55-
def lookupLoadableModuleClass(fqcn: String,
56-
loader: ClassLoader): Option[LoadableModuleClass] = {
56+
def lookupLoadableModuleClass(fqcn: String, loader: ClassLoader): Option[LoadableModuleClass] = {
5757
load(fqcn, loader).filter(isModuleClass).map(new LoadableModuleClass(_))
5858
}
5959

@@ -101,8 +101,7 @@ object Reflect {
101101
* @param loader
102102
* Class loader to use to load the class
103103
*/
104-
def lookupInstantiatableClass(fqcn: String,
105-
loader: ClassLoader): Option[InstantiatableClass] = {
104+
def lookupInstantiatableClass(fqcn: String, loader: ClassLoader): Option[InstantiatableClass] = {
106105
load(fqcn, loader).filter(isInstantiatableClass).map(new InstantiatableClass(_))
107106
}
108107

@@ -121,10 +120,10 @@ object Reflect {
121120
* inner class (non-local), both are the same non-null class.
122121
*/
123122
def isLocalClass: Boolean =
124-
clazz.getEnclosingClass() != clazz.getDeclaringClass()
123+
clazz.getEnclosingClass != clazz.getDeclaringClass
125124

126-
(clazz.getModifiers() & Modifier.ABSTRACT) == 0 &&
127-
clazz.getConstructors().length > 0 &&
125+
(clazz.getModifiers & Modifier.ABSTRACT) == 0 &&
126+
clazz.getConstructors.length > 0 &&
128127
!isModuleClass(clazz) &&
129128
!isLocalClass
130129
}
@@ -136,8 +135,7 @@ object Reflect {
136135
* `loadModule`.
137136
*/
138137
val clazz = Class.forName(fqcn, false, loader)
139-
if (inheritsAnnotation(clazz)) Some(clazz)
140-
else None
138+
Some(clazz).filter(inheritsAnnotation)
141139
} catch {
142140
case _: ClassNotFoundException => None
143141
}

0 commit comments

Comments
 (0)