Add support for Scala Native (#338)

Author: ekrich

.github/workflows/ci.yml

@@ -23,14 +23,12 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.13.5, 2.12.12, 3.0.0-M2, 3.0.0-M3]
+        scala: [2.13.5, 2.12.13, 3.0.0-RC2]
         java: [[email protected]]
-        platform: [jvm, js]
+        platform: [jvm, js, native]
         exclude:
-          - platform: js
-            scala: 3.0.0-M2
-          - platform: js
-            scala: 3.0.0-M3
+          - platform: native
+            scala: 3.0.0-RC2
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout current branch (full)
@@ -62,30 +60,34 @@ jobs:
         if: matrix.platform == 'js'
         run: sbt ++${{ matrix.scala }} js/checkCI
 
+      - name: Validate Native
+        if: matrix.platform == 'native'
+        run: sbt ++${{ matrix.scala }} native/checkCI
+
       - name: Validate JVM
-        if: matrix.platform == 'jvm' && matrix.scala != '2.12.12'
+        if: matrix.platform == 'jvm' && matrix.scala != '2.12.13'
         run: sbt ++${{ matrix.scala }} jvm/checkCI
 
       - name: Setup Python
-        if: matrix.platform == 'jvm' && matrix.scala == '2.12.12'
+        if: matrix.platform == 'jvm' && matrix.scala == '2.12.13'
         uses: actions/setup-python@v2
         with:
           python-version: 3.x
 
       - name: Setup codecov
-        if: matrix.platform == 'jvm' && matrix.scala == '2.12.12'
+        if: matrix.platform == 'jvm' && matrix.scala == '2.12.13'
         run: pip install codecov
 
       - name: Validate JVM (scala 2)
-        if: matrix.platform == 'jvm' && matrix.scala == '2.12.12'
-        run: sbt ++${{ matrix.scala }} coverage jvm/checkCI docs/mdoc coverageReport
+        if: matrix.platform == 'jvm' && matrix.scala == '2.12.13'
+        run: sbt ++${{ matrix.scala }} jvm/checkCI docs/mdoc
 
       - name: Upload Codecov Results
-        if: matrix.platform == 'jvm' && matrix.scala == '2.12.12'
+        if: matrix.platform == 'jvm' && matrix.scala == '2.12.13'
         run: codecov
 
       - name: Binary compatibility ${{ matrix.scala }}
-        if: matrix.platform == 'jvm' && matrix.scala == '2.12.12'
+        if: matrix.platform == 'jvm' && matrix.scala == '2.12.13'
         run: sbt ++${{ matrix.scala }} mimaReportBinaryIssues
 
   publish:
@@ -126,7 +128,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.13.5, 2.12.12, 3.0.0-M2, 3.0.0-M3]
+        scala: [2.13.5, 2.12.13, 3.0.0-RC2]
         java: [[email protected]]
     runs-on: ${{ matrix.os }}
     steps:
@@ -152,8 +154,8 @@ jobs:
             ~/Library/Caches/Coursier/v1
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
-      - if: matrix.platform == 'jvm' && matrix.scala == '2.12.12'
+      - if: matrix.platform == 'jvm' && matrix.scala == '2.12.13'
         run: sbt ++${{ matrix.scala }} scalafmtCheckAll
 
-      - if: matrix.platform == 'jvm' && matrix.scala == '2.12.12'
+      - if: matrix.platform == 'jvm' && matrix.scala == '2.12.13'
         run: sbt ++${{ matrix.scala }} scalafmtSbtCheck

build.sbt

@@ -1,27 +1,29 @@
 import sbtcrossproject.{crossProject, CrossType}
 
-val Scala212 = "2.12.12"
+val Scala212 = "2.12.13"
 val Scala213 = "2.13.5"
 
-ThisBuild / crossScalaVersions := Seq(Scala213, Scala212, "3.0.0-M2", "3.0.0-M3")
+ThisBuild / crossScalaVersions := Seq(Scala213, Scala212, "3.0.0-RC2")
 ThisBuild / scalaVersion := Scala213
 
 ThisBuild / githubWorkflowJavaVersions := Seq("[email protected]")
 
-ThisBuild / githubWorkflowBuildMatrixAdditions += "platform" -> List("jvm", "js")
+ThisBuild / githubWorkflowBuildMatrixAdditions += "platform" -> List("jvm", "js", "native")
 
 ThisBuild / githubWorkflowBuildMatrixExclusions ++=
   (ThisBuild / crossScalaVersions).value.filter(_.startsWith("3.")).map { dottyVersion =>
-    MatrixExclude(Map("platform" -> "js", "scala" -> dottyVersion))
+    MatrixExclude(Map("platform" -> "native", "scala" -> dottyVersion))
   }
 
 val JvmCond = s"matrix.platform == 'jvm'"
 val JsCond = s"matrix.platform == 'js'"
+val NativeCond = s"matrix.platform == 'native'"
 
 val Scala212Cond = s"matrix.scala == '$Scala212'"
 
 ThisBuild / githubWorkflowBuild := Seq(
   WorkflowStep.Sbt(List("js/checkCI"), name = Some("Validate JavaScript"), cond = Some(JsCond)),
+  WorkflowStep.Sbt(List("native/checkCI"), name = Some("Validate Native"), cond = Some(NativeCond)),
   WorkflowStep.Sbt(List("jvm/checkCI"),
                    name = Some("Validate JVM"),
                    cond = Some(JvmCond + " && " + s"matrix.scala != '$Scala212'")
@@ -35,7 +37,8 @@ ThisBuild / githubWorkflowBuild := Seq(
                    name = Some("Setup codecov"),
                    cond = Some(JvmCond + " && " + Scala212Cond)
   ),
-  WorkflowStep.Sbt(List("coverage", "jvm/checkCI", "docs/mdoc", "coverageReport"),
+  // Avoid coverage, see https://github.com/scoverage/sbt-scoverage/issues/319
+  WorkflowStep.Sbt(List(/*"coverage",*/ "jvm/checkCI", "docs/mdoc"/*, "coverageReport"*/),
                    name = Some("Validate JVM (scala 2)"),
                    cond = Some(JvmCond + " && " + Scala212Cond)
   ),
@@ -131,7 +134,12 @@ lazy val js = project
   .settings(noPublish)
   .aggregate(coreJS, catsJS)
 
-lazy val core = crossProject(JSPlatform, JVMPlatform)
+lazy val native = project
+  .in(file(".native"))
+  .settings(noPublish)
+  .aggregate(coreNative, catsNative)
+
+lazy val core = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .crossType(CrossType.Pure)
   .in(file("core"))
   .settings(
@@ -143,18 +151,20 @@ lazy val core = crossProject(JSPlatform, JVMPlatform)
       else previousArtifact(version.value, "core")
     },
     libraryDependencies ++= Seq(
-      "org.scalatestplus" %%% "scalacheck-1-15" % "3.2.3.0" % Test,
-      "org.scalatest" %%% "scalatest-funsuite" % "3.2.3" % Test
+      "org.scalatestplus" %%% "scalacheck-1-15" % "3.2.7.0" % Test,
+      "org.scalatest" %%% "scalatest-funsuite" % "3.2.7" % Test
     )
   )
   .disablePlugins(JmhPlugin)
   .jsSettings(commonJsSettings)
   .jvmSettings(commonJvmSettings)
+  .nativeSettings(commonNativeSettings)
 
 lazy val coreJVM = core.jvm
 lazy val coreJS = core.js
+lazy val coreNative = core.native
 
-lazy val cats = crossProject(JSPlatform, JVMPlatform)
+lazy val cats = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .crossType(CrossType.Full)
   .in(file("cats"))
   .dependsOn(core % "compile->compile;test->test")
@@ -163,9 +173,9 @@ lazy val cats = crossProject(JSPlatform, JVMPlatform)
     name := "paiges-cats",
     moduleName := "paiges-cats",
     libraryDependencies ++= Seq(
-      "org.typelevel" %%% "cats-core" % "2.4.1",
-      "org.typelevel" %%% "cats-laws" % "2.4.1" % Test,
-      "org.typelevel" %%% "discipline-scalatest" % "2.1.1" % Test
+      "org.typelevel" %%% "cats-core" % "2.5.0",
+      "org.typelevel" %%% "cats-laws" % "2.5.0" % Test,
+      "org.typelevel" %%% "discipline-scalatest" % "2.1.3" % Test
     ),
     mimaPreviousArtifacts := {
       if (isDotty.value) Set.empty
@@ -175,9 +185,11 @@ lazy val cats = crossProject(JSPlatform, JVMPlatform)
   .disablePlugins(JmhPlugin)
   .jsSettings(commonJsSettings)
   .jvmSettings(commonJvmSettings)
+  .nativeSettings(commonNativeSettings)
 
 lazy val catsJVM = cats.jvm
 lazy val catsJS = cats.js
+lazy val catsNative = cats.native
 
 lazy val benchmark = project
   .in(file("benchmark"))
@@ -270,13 +282,17 @@ lazy val commonJvmSettings = Seq(
 )
 
 lazy val commonJsSettings = Seq(
-  crossScalaVersions := crossScalaVersions.value.filter(_.startsWith("2.")),
   scalaJSStage in Global := FastOptStage,
   parallelExecution := false,
   jsEnv := new org.scalajs.jsenv.nodejs.NodeJSEnv(),
   coverageEnabled := false
 )
 
+lazy val commonNativeSettings = Seq(
+  crossScalaVersions := crossScalaVersions.value.filter(_.startsWith("2.")),
+  coverageEnabled := false
+)
+
 def previousArtifact(version: String, proj: String) = {
   def mod(x: Int, y: Int, z: Int): ModuleID =
     "org.typelevel" %% s"paiges-$proj" % s"$x.$y.$z"

cats/js/src/main/scala/org/typelevel/paiges/Platform.scala

@@ -5,5 +5,6 @@ private[paiges] object Platform {
   // $COVERAGE-OFF$
   final val isJvm = false
   final val isJs = true
+  final val isNative = false
   // $COVERAGE-ON$
 }

cats/jvm/src/main/scala/org/typelevel/paiges/Platform.scala

@@ -5,5 +5,6 @@ private[paiges] object Platform {
   // $COVERAGE-OFF$
   final val isJvm = true
   final val isJs = false
+  final val isNative = false
   // $COVERAGE-ON$
 }

cats/native/src/main/scala/org/typelevel/paiges/Platform.scala

@@ -0,0 +1,10 @@
+package org.typelevel.paiges
+
+private[paiges] object Platform {
+  // using `final val` makes compiler constant-fold any use of these values, dropping dead code automatically
+  // $COVERAGE-OFF$
+  final val isJvm = false
+  final val isJs = false
+  final val isNative = true
+  // $COVERAGE-ON$
+}

project/plugins.sbt

@@ -10,3 +10,5 @@ addSbtPlugin("ch.epfl.lamp" % "sbt-dotty" % "0.5.4")
 addSbtPlugin("com.codecommit" % "sbt-github-actions" % "0.10.1")
 addSbtPlugin("com.dwijnand" % "sbt-dynver" % "4.1.1")
 addSbtPlugin("io.crashbox" % "sbt-gpg" % "0.2.1")
+addSbtPlugin("org.portable-scala" % "sbt-scala-native-crossproject" % "1.0.0")
+addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.0")