Allow compilation on Scala 3 (#14)

* Move scala-native-p to scopt

* Move scala-native-ld to scopt

* Simplify ConfigConverterTest - remove redundant default calls

* Remove unnecessary comments and run scalafmt

* Remove no longer necessary structures

* Remove patching mechanizm

* Allow compilation with Scala3

To allow this, used scalatest version was updated.

* Add scala 3 testing to CI and fix tests

* Add missing option names

* Include scalatest only for unit tests

* scalafmt fix

* Pack correct scalalib for used scala version

* Fix scalalib resolution for Scala 3

Author: jchyb

.github/workflows/CI.yml

@@ -7,13 +7,13 @@ jobs:
       fail-fast: false
       matrix:
         OS: [ubuntu-18.04, windows-2019]
-        SN: [0.4.2]
+        scala: [2.12.15, 2.13.7, 3.1.0]
     steps:
       - uses: actions/checkout@v2
       - uses: olafurpg/setup-scala@v13
       - name: Test
         run: >
-         sbt 'set cli/scalaNativeVersion := "${{matrix.SN}}"'
+         sbt 'set cli/scalaVersion := "${{matrix.scala}}"'
          +cli/test
          +cliScriptedTests/scripted
         shell: bash

build.sbt

@@ -1,17 +1,50 @@
 val crossScalaVersions212 = (13 to 15).map(v => s"2.12.$v")
 val crossScalaVersions213 = (4 to 7).map(v => s"2.13.$v")
+val crossScalaVersions3 = Seq("3.1.0")
 val latestsScalaVersions =
-  Seq(crossScalaVersions212.last, crossScalaVersions213.last)
+  Seq(crossScalaVersions212, crossScalaVersions213, crossScalaVersions3).map(
+    _.last
+  )
 
 def scalaReleasesForBinaryVersion(v: String): Seq[String] = v match {
   case "2.12" => crossScalaVersions212
   case "2.13" => crossScalaVersions213
+  case "3"    => crossScalaVersions3
   case ver =>
     throw new IllegalArgumentException(
       s"Unsupported binary scala version `${ver}`"
     )
 }
 
+def scalaStdlibForBinaryVersion(
+    nativeBinVer: String,
+    scalaBinVer: String
+): Seq[String] = {
+  def depPattern(lib: String, v: String) =
+    s"${lib}_native${nativeBinVer}_${v}"
+  val scalalib = "scalalib"
+  val scala3lib = "scala3lib"
+  val commonLibs = Seq(
+    "nativelib",
+    "clib",
+    "posixlib",
+    "windowslib",
+    "javalib",
+    "auxlib"
+  )
+  scalaBinVer match {
+    case "2.12" | "2.13" =>
+      (commonLibs :+ scalalib).map(depPattern(_, scalaBinVer))
+    case "3" =>
+      (commonLibs :+ scala3lib).map(depPattern(_, scalaBinVer)) :+
+        depPattern(scalalib, "2.13")
+    case ver =>
+      throw new IllegalArgumentException(
+        s"Unsupported binary scala version `${ver}`"
+      )
+  }
+}
+
 val scalaNativeVersion =
   settingKey[String]("Version of Scala Native for which to build to CLI")
 
@@ -57,8 +90,8 @@ lazy val cli = project
     scalacOptions += "-Ywarn-unused:imports",
     libraryDependencies ++= Seq(
       "org.scala-native" %% "tools" % scalaNativeVersion.value,
-      "com.github.alexarchambault" %% "case-app" % "2.1.0-M10",
-      "org.scalatest" %% "scalatest" % "3.1.1" % Test
+      "com.github.scopt" %% "scopt" % "4.0.1",
+      "org.scalatest" %% "scalatest" % "3.2.10" % Test
     ),
     buildInfoKeys := Seq[BuildInfoKey](
       "nativeVersion" -> scalaNativeVersion.value
@@ -108,23 +141,19 @@ lazy val cliPackSettings = Def.settings(
     val scalaNativeOrg = organization.value
     val scalaBinVer = scalaBinaryVersion.value
     val snVer = scalaNativeVersion.value
+    val nativeBinVer =
+      ScalaNativeCrossVersion.binaryVersion(snVer.stripSuffix("-SNAPSHOT"))
 
     val scalaFullVers = scalaReleasesForBinaryVersion(scalaBinVer)
     val cliAssemblyJar = assembly.value
 
+    val scalaStdLibraryModuleIDs =
+      scalaStdlibForBinaryVersion(nativeBinVer, scalaBinVer)
+
     // Standard modules needed for linking of Scala Native
-    val stdLibModuleIDs = Seq(
-      "nativelib",
-      "clib",
-      "posixlib",
-      "windowslib",
-      "javalib",
-      "auxlib",
-      "scalalib"
-    ).map { lib =>
-      val nativeBinVersion = ScalaNativeCrossVersion.binaryVersion(snVer)
-      scalaNativeOrg % s"${lib}_native${nativeBinVersion}_${scalaBinVer}" % snVer
-    }
+    val stdLibModuleIDs = scalaStdLibraryModuleIDs.map(
+      scalaNativeOrg % _ % snVer
+    )
     val compilerPluginModuleIDs =
       scalaFullVers.map(v => scalaNativeOrg % s"nscplugin_$v" % snVer)
     val allModuleIDs = (stdLibModuleIDs ++ compilerPluginModuleIDs).toVector
@@ -134,7 +163,9 @@ lazy val cliPackSettings = Def.settings(
       val retrieveDir = s.cacheDirectory / "cli-lib-jars"
       val lm = {
         import sbt.librarymanagement.ivy._
-        val ivyConfig = InlineIvyConfiguration().withLog(log)
+        val ivyConfig = InlineIvyConfiguration()
+          .withResolvers(resolvers.value.toVector)
+          .withLog(log)
         IvyDependencyResolution(ivyConfig)
       }
       val dummyModuleName =
@@ -190,7 +221,7 @@ lazy val cliPackSettings = Def.settings(
         .replaceAllLiterally("@SCALANATIVE_VER@", snVer)
         .replaceAllLiterally(
           "@SCALANATIVE_BIN_VER@",
-          ScalaNativeCrossVersion.binaryVersion(snVer)
+          ScalaNativeCrossVersion.binaryVersion(snVer.stripSuffix("-SNAPSHOT"))
         )
       val dest = trgBin / scriptFile.getName
       IO.write(dest, processedContent)

cli/src/main/scala/scala/scalanative/cli/ScalaNativeLd.scala

@@ -3,24 +3,59 @@ package scala.scalanative.cli
 import scala.scalanative.build.Build
 import scala.scalanative.util.Scope
 import scala.scalanative.cli.utils.ConfigConverter
-import scala.scalanative.cli.utils.NativeConfigParserImplicits._
 import scala.scalanative.cli.options.LinkerOptions
-import caseapp.core.app.CaseApp
-import caseapp.core.RemainingArgs
 import scala.scalanative.cli.options.BuildInfo
+import scala.scalanative.cli.options.ConfigOptions
+import scala.scalanative.cli.options.NativeConfigOptions
 
-object ScalaNativeLd extends CaseApp[LinkerOptions] {
+object ScalaNativeLd {
 
-  override def ignoreUnrecognized: Boolean = true
+  def main(args: Array[String]): Unit = {
+    val parser = new scopt.OptionParser[LinkerOptions]("scala-native-ld") {
+      override def errorOnUnknownArgument = false
+      head("scala-native-ld", BuildInfo.nativeVersion)
+      arg[String]("classpath")
+        .hidden()
+        .optional()
+        .unbounded()
+        .action((x, c) => c.copy(classpath = c.classpath :+ x))
 
-  def run(options: LinkerOptions, args: RemainingArgs) = {
-    if (options.misc.version) {
-      println(BuildInfo.nativeVersion)
-    } else if (options.config.main.isEmpty) {
+      ConfigOptions.set(this)
+      NativeConfigOptions.set(this)
+
+      note("Logger options:")
+      opt[Unit]("verbose")
+        .abbr("v")
+        .optional()
+        .unbounded()
+        .action((x, c) => c.copy(verbose = c.verbose + 1))
+        .text(
+          "Increase verbosity of internal logger. Can be specified multiple times."
+        )
+
+      note("Help options:")
+      help('h', "help")
+        .text("Print this usage text and exit.")
+      version("version")
+        .text("Print scala-native-cli version and exit.")
+    }
+    parser.parse(args, LinkerOptions()) match {
+      case Some(config) =>
+        runLd(config)
+        sys.exit(0)
+      case _ =>
+        // arguments are of bad format, scopt will have displayed errors automatically
+        sys.exit(1)
+    }
+  }
+
+  def runLd(options: LinkerOptions) = {
+    if (options.config.main.isEmpty) {
       println("Required option not specified: --main")
-      exit(1)
+      sys.exit(1)
     } else {
-      val (ignoredArgs, classpath) = args.all.partition(_.startsWith("-"))
+      val (ignoredArgs, classpath) =
+        options.classpath.partition(_.startsWith("-"))
       ignoredArgs.foreach { arg =>
         println(s"Unrecognised argument: ${arg}")
       }
@@ -30,7 +65,7 @@ object ScalaNativeLd extends CaseApp[LinkerOptions] {
       buildOptionsMaybe match {
         case Left(thrown) =>
           System.err.println(thrown.getMessage())
-          exit(1)
+          sys.exit(1)
         case Right(buildOptions) =>
           Scope { implicit scope =>
             Build.build(buildOptions.config, buildOptions.outpath)

cli/src/main/scala/scala/scalanative/cli/ScalaNativeP.scala

@@ -1,7 +1,5 @@
 package scala.scalanative.cli
 
-import caseapp.core.app.CaseApp
-import caseapp.core.RemainingArgs
 import java.nio.file.Paths
 import java.io.File
 import scala.scalanative.util.Scope
@@ -16,20 +14,47 @@ import scala.scalanative.nir.Defn
 import scala.annotation.tailrec
 import java.nio.ByteBuffer
 
-object ScalaNativeP extends CaseApp[PrinterOptions] {
+object ScalaNativeP {
 
-  def run(options: PrinterOptions, args: RemainingArgs): Unit = {
-    if (options.misc.version) {
-      println(BuildInfo.nativeVersion)
-      exit(0)
+  def main(args: Array[String]): Unit = {
+
+    val parser = new scopt.OptionParser[PrinterOptions]("scala-native-p") {
+      override def errorOnUnknownArgument = false
+
+      head("scala-native-p", BuildInfo.nativeVersion)
+      arg[String]("Class names")
+        .hidden()
+        .optional()
+        .unbounded()
+        .action((x, c) => c.copy(classNames = c.classNames :+ x))
+
+      note("Help options:")
+      help('h', "help")
+        .text("Print this usage text and exit.")
+      version("version")
+        .text("Print scala-native-cli version and exit.")
+
+      note("Other options:")
+      PrinterOptions.set(this)
     }
 
-    if (args.all.isEmpty) {
+    parser.parse(args, PrinterOptions()) match {
+      case Some(config) =>
+        runPrinter(config)
+        sys.exit(0)
+      case _ =>
+        // arguments are of bad format, scopt will have displayed errors automatically
+        sys.exit(1)
+    }
+  }
+
+  private def runPrinter(options: PrinterOptions): Unit = {
+    if (options.classNames.isEmpty) {
       if (options.fromPath)
         System.err.println("Required NIR file not specified.")
       else
         System.err.println("Required class/object not specified.")
-      exit(1)
+      sys.exit(1)
     }
 
     val (classpath, ignoredPaths) =
@@ -41,8 +66,8 @@ object ScalaNativeP extends CaseApp[PrinterOptions] {
       System.err.println(s"Ignoring non existing path: $path")
     }
 
-    if (options.fromPath) printFromFiles(classpath, args.all)
-    else printFromNames(classpath, args.all)
+    if (options.fromPath) printFromFiles(classpath, options.classNames)
+    else printFromNames(classpath, options.classNames)
   }
 
   private def printFromNames(
@@ -118,7 +143,7 @@ object ScalaNativeP extends CaseApp[PrinterOptions] {
 
   private def fail(msg: String): Nothing = {
     Console.err.println(msg)
-    exit(1)
+    sys.exit(1)
   }
 
 }

cli/src/main/scala/scala/scalanative/cli/options/ConfigOptions.scala

@@ -1,21 +1,33 @@
 package scala.scalanative.cli.options
 
-import caseapp._
+import scopt.OptionParser
 
 case class ConfigOptions(
-    @Group("Config")
-    @HelpMessage("Required main class.")
-    @ValueDescription("<main>")
     main: Option[String] = None,
-    @Group("Config")
-    @ExtraName("o")
-    @HelpMessage(
-      "Path of the resulting output binary. [./scala-native-out]"
-    )
-    @ValueDescription("<output-path>")
     outpath: String = "scala-native-out",
-    @Group("Config")
-    @HelpMessage("Scala Native working directory. [.]")
-    @ValueDescription("<path-to-directory>")
     workdir: String = "."
 )
+
+object ConfigOptions {
+  def set(parser: OptionParser[LinkerOptions]) = {
+    parser.note("Config options:")
+    parser
+      .opt[String]("main")
+      .valueName("<main>")
+      .optional()
+      .action((x, c) => c.copy(config = c.config.copy(main = Some(x))))
+      .text("Required main class.")
+    parser
+      .opt[String]('o', "outpath")
+      .valueName("<output-path>")
+      .optional()
+      .action((x, c) => c.copy(config = c.config.copy(outpath = x)))
+      .text("Path of the resulting output binary. [./scala-native-out]")
+    parser
+      .opt[String]("workdir")
+      .valueName("<path-to-directory>")
+      .optional()
+      .action((x, c) => c.copy(config = c.config.copy(workdir = x)))
+      .text("Scala Native working directory. [.]")
+  }
+}

cli/src/main/scala/scala/scalanative/cli/options/LinkerOptions.scala

@@ -1,17 +1,8 @@
 package scala.scalanative.cli.options
 
-import caseapp._
-
-@AppName("ScalaNativeLd")
-@ProgName("scala-native-ld")
-@ArgsName("classpath")
 case class LinkerOptions(
-    @Recurse
-    config: ConfigOptions,
-    @Recurse
-    nativeConfig: NativeConfigOptions,
-    @Recurse
-    logger: LoggerOptions,
-    @Recurse
-    misc: MiscOptions
+    classpath: List[String] = Nil,
+    config: ConfigOptions = ConfigOptions(),
+    nativeConfig: NativeConfigOptions = NativeConfigOptions(),
+    verbose: Int = 0
 )