Change option structure to make main a required option

Linktime property parsing was also adjusted to parse values as strings.
Unrecognized options are now being allowed, with a warning message.
Test were adjusted to accomodate changes.

Author: jchyb

cli/src/main/scala/scala/scalanative/cli/ScalaNativeCli.scala

@@ -11,16 +11,27 @@ import scala.scalanative.cli.options.BuildInfo
 
 object ScalaNativeCli extends CaseApp[CliOptions] {
 
+  override def ignoreUnrecognized: Boolean = true
+
   def run(options: CliOptions, args: RemainingArgs) = {
     if (options.misc.version) {
       println(BuildInfo.nativeVersion)
+    } else if (options.config.main == None) {
+      println("Required option not specified: --main")
+      exit(1)
     } else {
-      val positionalArgs = args.all
-      val buildOptionsMaybe = ConfigConverter.convert(options, positionalArgs)
+      val ignoredArgs = args.all.filter(_.startsWith("--"))
+      ignoredArgs.foreach { arg =>
+        println(s"Unrecognised argument: ${arg}")
+      }
+      val main = options.config.main.get
+      val classpath = args.all.filter(!_.startsWith("--"))
+      val buildOptionsMaybe = ConfigConverter.convert(options, main, classpath)
 
       buildOptionsMaybe match {
         case Left(thrown) =>
           System.err.println(thrown.getMessage())
+          exit(1)
         case Right(buildOptions) =>
           Scope { implicit scope =>
             Build.build(buildOptions.config, buildOptions.outpath)

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

@@ -4,7 +4,7 @@ import caseapp._
 
 @AppName("ScalaNativeCli")
 @ProgName("scala-native-cli")
-@ArgsName("main-class] [nir-sources")
+@ArgsName("classpath")
 case class CliOptions(
     @Recurse
     config: ConfigOptions,

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

@@ -3,10 +3,14 @@ package scala.scalanative.cli.options
 import caseapp._
 
 case class ConfigOptions(
+    @Group("Config")
+    @HelpMessage("Required main class.")
+    @ValueDescription("<main>")
+    main: Option[String] = None,
     @Group("Config")
     @ExtraName("o")
     @HelpMessage(
-      "Required path of the resulting output binary. [./scala-native-out]"
+      "Path of the resulting output binary. [./scala-native-out]"
     )
     @ValueDescription("<output-path>")
     outpath: String = "scala-native-out",

cli/src/main/scala/scala/scalanative/cli/utils/ConfigConverter.scala

@@ -18,17 +18,16 @@ object ConfigConverter {
 
   def convert(
       options: CliOptions,
-      positionalArgs: Seq[String]
+      main: String,
+      classpath: Seq[String]
   ): Either[Throwable, BuildOptions] = {
-    if (positionalArgs.size < 2) {
+    if (classpath.size == 0) {
       Left(
         new IllegalArgumentException(
-          "Not enough positional arguments. Main and at least one source file need to be specified."
+          "Classpath not specified. Pass classpath files as positional arguments."
         )
       )
     } else {
-      val main = positionalArgs.head
-      val classpath = positionalArgs.tail
       generateConfig(options, main, classpath).flatMap(config =>
         Try(Paths.get(options.config.outpath)).toEither.map(outpath =>
           BuildOptions(config, outpath)

cli/src/test/scala/scala/scalanative/cli/ConfigConverterTest.scala

@@ -16,11 +16,12 @@ import scala.scalanative.cli.options.MiscOptions
 class ConfigConverterTest extends AnyFlatSpec {
   val dummyLoggerOptions = LoggerOptions()
   val dummyNativeConfigOptions = NativeConfigOptions()
-  val dummyConfigOptions = ConfigOptions()
+  val dummyConfigOptions = ConfigOptions(main = Some("Main$"))
   val dummyMiscOptions = MiscOptions()
 
   val dummyArguments =
-    Seq("Main$", "A.nir", "B.nir")
+    Seq("A.jar", "B.jar")
+  val dummyMain = "Main$"
 
   val dummyCliOptions = CliOptions(
     config = dummyConfigOptions,
@@ -30,18 +31,15 @@ class ConfigConverterTest extends AnyFlatSpec {
   )
 
   "ArgParser" should "parse default options" in {
-    val config = ConfigConverter.convert(dummyCliOptions, dummyArguments)
+    val config =
+      ConfigConverter.convert(dummyCliOptions, dummyMain, dummyArguments)
     assert(config.isRight)
   }
 
   it should "report incomplete arguments" in {
     val noArgs = Seq()
-    val noArgsResult = ConfigConverter.convert(dummyCliOptions, noArgs)
-    assert(noArgsResult.isLeft)
-    assert(noArgsResult.left.get.isInstanceOf[IllegalArgumentException])
-
-    val mainOnly = Seq("Main$")
-    val mainOnlyResult = ConfigConverter.convert(dummyCliOptions, mainOnly)
+    val mainOnlyResult =
+      ConfigConverter.convert(dummyCliOptions, dummyMain, noArgs)
     assert(mainOnlyResult.isLeft)
     assert(mainOnlyResult.left.get.isInstanceOf[IllegalArgumentException])
   }
@@ -59,7 +57,7 @@ class ConfigConverterTest extends AnyFlatSpec {
     )
 
     val config =
-      ConfigConverter.convert(dummyCliOptions, Seq("$Main") ++ classPathStrings)
+      ConfigConverter.convert(dummyCliOptions, dummyMain, classPathStrings)
 
     assert(config != None)
     assert(config.right.get.config.classPath.sameElements(expected))
@@ -76,7 +74,11 @@ class ConfigConverterTest extends AnyFlatSpec {
         dummyMiscOptions
       )
       val config =
-        ConfigConverter.convert(options, dummyArguments).right.get.config
+        ConfigConverter
+          .convert(options, dummyMain, dummyArguments)
+          .right
+          .get
+          .config
       assert(config.compilerConfig.gc == expectedGC)
     }
     gcAssertion("immix", GC.immix)
@@ -96,7 +98,11 @@ class ConfigConverterTest extends AnyFlatSpec {
         dummyMiscOptions
       )
       val config =
-        ConfigConverter.convert(options, dummyArguments).right.get.config
+        ConfigConverter
+          .convert(options, dummyMain, dummyArguments)
+          .right
+          .get
+          .config
       assert(config.compilerConfig.mode == expectedMode)
     }
     modeAssertion("debug", Mode.debug)
@@ -115,7 +121,11 @@ class ConfigConverterTest extends AnyFlatSpec {
         dummyMiscOptions
       )
       val config =
-        ConfigConverter.convert(options, dummyArguments).right.get.config
+        ConfigConverter
+          .convert(options, dummyMain, dummyArguments)
+          .right
+          .get
+          .config
       assert(config.compilerConfig.lto == expectedLto)
     }
     ltoAssertion("none", LTO.none)
@@ -141,7 +151,7 @@ class ConfigConverterTest extends AnyFlatSpec {
     )
 
     val nativeConfig =
-      ConfigConverter.convert(options, dummyArguments).right.get
+      ConfigConverter.convert(options, dummyMain, dummyArguments).right.get
 
     assert(nativeConfig.config.compilerConfig.clang == expectedClangPath)
     assert(nativeConfig.config.compilerConfig.clangPP == expectedClangPPPath)
@@ -160,13 +170,13 @@ class ConfigConverterTest extends AnyFlatSpec {
       dummyMiscOptions
     )
     val default = ConfigConverter
-      .convert(dummyCliOptions, dummyArguments)
+      .convert(dummyCliOptions, dummyMain, dummyArguments)
       .right
       .get
       .config
       .compilerConfig
     val nonDefault = ConfigConverter
-      .convert(options, dummyArguments)
+      .convert(options, dummyMain, dummyArguments)
       .right
       .get
       .config

cli/version_0.4.0/src/main/scala/scala/scalanative/cli/options/NativeConfigOptions.scala

@@ -53,6 +53,7 @@ case class NativeConfigOptions(
     @ValueDescription("<path-to-clang>")
     clang: Option[String] = None,
     @Group("Native Config")
+    @Name("clang++")
     @HelpMessage(
       "Path to the `clang++` executable. Internally discovered if not specified."
     )

cli/version_newer/src/main/scala/scala/scalanative/cli/utils/LinktimePropertyParser.scala

@@ -25,12 +25,8 @@ object LinktimePropertyParser {
           ) {
             Left(getLtpPatternException(inputPattern))
           } else {
-            val (key, booleanString) = (matcher.group(1), matcher.group(2))
-
-            Try(booleanString.toBoolean).toEither match {
-              case Right(value) => Right((key, value))
-              case Left(value)  => Left(value)
-            }
+            val (key, value) = (matcher.group(1), matcher.group(2))
+            Right((key, value))
           }
         }
 

cli/version_newer/src/test/scala/scala/scalanative/cli/LinktimePropertyParserTest.scala

@@ -8,7 +8,7 @@ class LinktimePropertyParserTest extends AnyFlatSpec {
   "LinktimePropertyParser" should "handle boolean value types correctly" in {
     val input = List("isTesting=true", "isNotTesting=False")
     val expected =
-      Map[String, Any]("isTesting" -> true, "isNotTesting" -> false)
+      Map[String, Any]("isTesting" -> "true", "isNotTesting" -> "False")
     val obtained = LinktimePropertyParser.toMap(input)
     assert(obtained.right.get == expected)
   }
@@ -21,24 +21,6 @@ class LinktimePropertyParserTest extends AnyFlatSpec {
     val noKey = List("=true")
     val obtainedNoKey = LinktimePropertyParser.toMap(noKey)
     assert(obtainedNoKey.isLeft)
-
-    val noBoolean = List("key=")
-    val obtainedNoBoolean = LinktimePropertyParser.toMap(noBoolean)
-    assert(obtainedNoBoolean.isLeft)
-  }
-
-  it should "return error on non boolean values" in {
-    val withString = List("key=string")
-    val obtainedWithString = LinktimePropertyParser.toMap(withString)
-    assert(obtainedWithString.isLeft)
-
-    val withNull = List("key=null")
-    val obtainedWithNull = LinktimePropertyParser.toMap(withNull)
-    assert(obtainedWithNull.isLeft)
-
-    val withFloat = List("key=1.1")
-    val obtainedWithFloat = LinktimePropertyParser.toMap(withFloat)
-    assert(obtainedWithFloat.isLeft)
   }
 
 }

scala-native-cli-integration-test-runner/src/test/run/integration-test/test

@@ -4,28 +4,28 @@
 > runCli --version
 
 # -- Link and check if outpath exists
-> runCli --outpath target/out1 -v -v Main$ 
+> runCli --outpath target/out1 -v -v --main Main$ 
 $ exists target/out1
 
 # -- Fail to link without main specified
 > runCli --outpath target/out2 -v -v
 -$ exists target/out2
 
 # -- Fail to link with an incorrect option
-> runCli --outpath target/out3 -v -v --gc fast Main$ 
+> runCli --outpath target/out3 -v -v --gc fast --main Main$ 
 -$ exists target/out3
 
-# -- Fail to link with an unspecified option
-> runCli --outpath target/out4 -v -v --unspecified Main$ 
--$ exists target/out4
+# -- Link even with an unspecified option
+> runCli --outpath target/out4 -v -v --unspecified --main Main$ 
+$ exists target/out4
 
 # -- Do not write nir files if not specified
-> runCli --outpath target/out5 -v -v Main$ 
+> runCli --outpath target/out5 -v -v --main Main$ 
 -$ exists optimized.hnir
 $ exists target/out5
 
 # -- Write nir files to workdir if specified
 $ mkdir native-dir
-> runCli --outpath target/out6 -v -v --workdir native-dir --dump Main$
+> runCli --outpath target/out6 -v -v --workdir native-dir --dump --main Main$
 $ exists native-dir/optimized.hnir
 $ exists target/out6