add/parametrize endpoints, some refactoring (#8)

* add/parametrize endpoints, some refactoring

* fix codegen task in ci

* revert package name change

* add exit code to command line process

Author: rolang

README.md

@@ -3,16 +3,29 @@
 ![Maven Central Version](https://img.shields.io/maven-central/v/dev.rolang/gcp-codegen_3)
 [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.rolang/gcp-codegen_3.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/rolang/gcp-codegen_3/)
 
-Generates client code from Google's [disovery document](https://developers.google.com/discovery/v1/using).
-Currently generates code for Scala 3.
+⚠️ _This project is in an experimental stage (with a messy code base), use with care if you want to give it a try_.
+
+Generates client code from Google's [disovery document](https://developers.google.com/discovery/v1/using) for your Scala (3) tech stack.  
+Currently it provides following configurations for generated code:
+ - Http sources: [Sttp4](https://sttp.softwaremill.com/en/latest), [Sttp3](https://sttp.softwaremill.com/en/stable)
+ - JSON codecs: [Jsoniter](https://github.com/plokhotnyuk/jsoniter-scala), [ZioJson](https://zio.dev/zio-json)
+ - JSON Array collection type: `List`, `Vector`, `Array`, `ZioChunk`
+
+__NOTE__: Generated code does not include authentication.
+
+If you're using [http4s](https://github.com/http4s/http4s) and [circe](https://github.com/circe/circe) you may also want to check some similar projects:
+ - [hamnis/google-discovery-scala](https://github.com/hamnis/google-discovery-scala)
+ - [armanbilge/gcp4s](https://github.com/armanbilge/gcp4s)
 
 ### Usage
 
+The generator can be used with any tool that can perform system calls to a command line executable or add Scala 3 dependencies (e.g. [scala command line](https://scala-cli.virtuslab.org/), [sbt 1](https://www.scala-sbt.org/1.x/docs/), [sbt 2](https://www.scala-sbt.org/2.x/docs/en/index.html), [mill](https://mill-build.org), etc.).  
+
 #### Usage via Scala command line example
 See example under [example/generate.scala](./example/generate.scala).
 
 ```scala
-//> using scala 3.6.2
+//> using scala 3.6.3
 //> using dep dev.rolang::gcp-codegen::0.0.1
 
 import gcp.codegen.*, java.nio.file.*, GeneratorConfig.*
@@ -22,8 +35,7 @@ import gcp.codegen.*, java.nio.file.*, GeneratorConfig.*
     specsInput = SpecsInput.FilePath(Path.of("pubsub_v1.json")),
     config = GeneratorConfig(
       outDir = Path.of("out"),
-      resourcesPkg = "example.pubsub.v1.resource",
-      schemasPkg = "example.pubsub.v1.schemas",
+      outPkg = "example.pubsub.v1",
       httpSource = HttpSource.Sttp4,
       jsonCodec = JsonCodec.Jsoniter,
       dialect = Dialect.Scala3,
@@ -35,7 +47,7 @@ import gcp.codegen.*, java.nio.file.*, GeneratorConfig.*
 ```
 Run example:
 ```shell
-cd example && scala generate.scala
+cd example && scala generate.scala && scala fmt ./out
 ```
 See output in `example/out`.
 
@@ -45,14 +57,13 @@ See output in `example/out`.
 
 | Configuration       | Description | Options | Default |
 | ------------------- | ---------------- | ------- | --- |
-| --out-dir           | Ouput directory | | |
-| --specs             | Can be `stdin` or a path to the JSON file. | | |
-| --resources-pkg     | Target package for generated resources |  | |
-| --schemas-pkg       | Target package for generated schemas |  | |
-| --http-source       | Generated http source. | [Sttp4](https://sttp.softwaremill.com/en/latest), [Sttp3](https://sttp.softwaremill.com/en/stable) | |
-| --json-codec        | Generated JSON codec | [Jsoniter](https://github.com/plokhotnyuk/jsoniter-scala), [ZioJson](https://zio.dev/zio-json)  | |
-| --array-type        | Collection type for JSON arrays | `List`, `Vector`, `Array`, `ZioChunk` | `List` |
-| --include-resources | Optional resource filter. | | |
+| -specs             | Can be `stdin` or a path to the JSON file. | | |
+| -out-dir           | Ouput directory | | |
+| -out-pkg           | Output package |  | |
+| -http-source       | Generated http source. | [Sttp4](https://sttp.softwaremill.com/en/latest), [Sttp3](https://sttp.softwaremill.com/en/stable) | |
+| -json-codec        | Generated JSON codec | [Jsoniter](https://github.com/plokhotnyuk/jsoniter-scala), [ZioJson](https://zio.dev/zio-json)  | |
+| -array-type        | Collection type for JSON arrays | `List`, `Vector`, `Array`, `ZioChunk` | `List` |
+| -include-resources | Optional resource filter. | | |
 
 ##### Examples:
 

build.sbt

@@ -2,9 +2,7 @@ ThisBuild / description := "Google Cloud client code generator"
 ThisBuild / organization := "dev.rolang"
 ThisBuild / licenses := Seq(License.MIT)
 ThisBuild / homepage := Some(url("https://github.com/rolang/google-rest-api-codegen"))
-ThisBuild / scalaVersion := "3.3.4"
-ThisBuild / scalafmt := true
-ThisBuild / scalafmtSbtCheck := true
+ThisBuild / scalaVersion := "3.3.5"
 ThisBuild / version ~= { v => if (v.contains('+')) s"${v.replace('+', '-')}-SNAPSHOT" else v }
 ThisBuild / scmInfo := Some(
   ScmInfo(
@@ -46,7 +44,7 @@ lazy val noPublish = Seq(
   publish / skip := true
 )
 
-lazy val sttpClient4Version = "4.0.0-M22"
+lazy val sttpClient4Version = "4.0.0-RC1"
 
 lazy val sttpClient3Version = "3.10.2"
 
@@ -78,7 +76,7 @@ lazy val core = crossProject(JVMPlatform, NativePlatform)
   )
   .settings(
     libraryDependencies ++= Seq(
-      "com.lihaoyi" %%% "upickle" % "4.0.2"
+      "com.lihaoyi" %%% "upickle" % "4.1.0"
     )
   )
 
@@ -90,7 +88,8 @@ lazy val cli = project
   .settings(publishSettings)
   .settings(
     name := "gcp-codegen-cli",
-    moduleName := "gcp-codegen-cli"
+    moduleName := "gcp-codegen-cli",
+    nativeConfig := nativeConfig.value.withMultithreading(false)
   )
 
 def dependencyByConfig(httpSource: String, jsonCodec: String, arrayType: String): List[ModuleID] = {
@@ -219,13 +218,12 @@ def codegenTask(
     val cmd =
       List(
         s"./${cliBin.getPath()}",
-        s"--specs=${resourcePath(s"${apiName}_$apiVersion.json")}",
-        s"--resources-pkg=$basePkgName.resources",
-        s"--schemas-pkg=$basePkgName.schemas",
-        s"--out-dir=${outSrcDir.getPath()}",
-        s"--http-source=$httpSource",
-        s"--json-codec=$jsonCodec",
-        s"--array-type=$arrayType"
+        s"-specs=${resourcePath(s"${apiName}_$apiVersion.json")}",
+        s"-out-dir=${outSrcDir.getPath()}",
+        s"-out-pkg=$basePkgName",
+        s"-http-source=$httpSource",
+        s"-json-codec=$jsonCodec",
+        s"-array-type=$arrayType"
       ).mkString(" ")
 
     cmd ! ProcessLogger(l => logger.info(l))

example/generate.scala

@@ -1,5 +1,5 @@
-//> using scala 3.6.2
-//> using dep dev.rolang::gcp-codegen::0.0.1
+//> using scala 3.6.3
+//> using dep dev.rolang::gcp-codegen::0.0.2
 
 import gcp.codegen.*, java.nio.file.*, GeneratorConfig.*
 
@@ -8,8 +8,7 @@ import gcp.codegen.*, java.nio.file.*, GeneratorConfig.*
     specsInput = SpecsInput.FilePath(Path.of("pubsub_v1.json")),
     config = GeneratorConfig(
       outDir = Path.of("out"),
-      resourcesPkg = "example.pubsub.v1.resource",
-      schemasPkg = "example.pubsub.v1.schemas",
+      outPkg = "example.pubsub.v1",
       httpSource = HttpSource.Sttp4,
       jsonCodec = JsonCodec.Jsoniter,
       dialect = Dialect.Scala3,

modules/cli/src/main/scala/cli.scala

@@ -1,3 +1,9 @@
+// for test runs using scala-cli
+//> using jvm system
+//> using scala 3.6.3
+//> using file ../../../../core/shared/src/main/scala/codegen.scala
+//> using dep com.lihaoyi::upickle:4.1.0
+
 package gcp.codegen.cli
 
 import gcp.codegen.*
@@ -11,13 +17,19 @@ import scala.util.{Failure, Success}
 
 @main def run(args: String*) =
   argsToTask(args) match
-    case Left(err) => Console.err.println(s"Invalid arguments: $err")
+    case Left(err) =>
+      Console.err.println(s"Invalid arguments: $err")
+      sys.exit(1)
     case Right(task) =>
       Await
         .ready(task.run, 30.seconds)
         .onComplete {
-          case Failure(exception) => Console.err.println(s"Failure: ${exception.printStackTrace()}")
-          case Success(files)     => println(s"Generated ${files.length} files")
+          case Failure(exception) =>
+            Console.err.println(s"Failure: ${exception.printStackTrace()}")
+            sys.exit(1)
+          case Success(files) =>
+            println(s"Generated ${files.length} files")
+            sys.exit(0)
         }
 
 private def argsToTask(args: Seq[String]): Either[String, Task] =
@@ -31,41 +43,39 @@ private def argsToTask(args: Seq[String]): Either[String, Task] =
 
   for {
     outDir <- argsMap
-      .get("--out-dir")
+      .get("-out-dir")
       .map(p => Path.of(p))
-      .toRight("Missing --out-dir")
+      .toRight("Missing -out-dir")
     specs <- argsMap
-      .get("--specs")
+      .get("-specs")
       .map {
         case "stdin" => SpecsInput.StdIn
         case p       => SpecsInput.FilePath(Path.of(p))
       }
-      .toRight("Missing --specs")
-    resourcesPkg <- argsMap
-      .get("--resources-pkg")
-      .toRight("Missing --resources-pkg")
-    schemasPkg <- argsMap.get("--schemas-pkg").toRight("Missing --schemas-pkg")
+      .toRight("Missing -specs")
+    outPkg <- argsMap
+      .get("-out-pkg")
+      .toRight("Missing -out-pkg")
     httpSource <- argsMap
-      .get("--http-source")
+      .get("-http-source")
       .flatMap(v => HttpSource.values.find(_.toString().equalsIgnoreCase(v)))
-      .toRight("Missing or invalid --http-source")
+      .toRight("Missing or invalid -http-source")
     jsonCodec <- argsMap
-      .get("--json-codec")
+      .get("-json-codec")
       .flatMap(v => JsonCodec.values.find(_.toString().equalsIgnoreCase(v)))
-      .toRight("Missing or invalid --json-codec")
-    arrayType <- argsMap.get("--array-type") match
+      .toRight("Missing or invalid -json-codec")
+    arrayType <- argsMap.get("-array-type") match
       case None    => Right(ArrayType.List)
       case Some(v) => ArrayType.values.find(_.toString().equalsIgnoreCase(v)).toRight(s"Invalid array-type $v")
     incResources = argsMap
-      .get("--include-resources")
+      .get("-include-resources")
       .toList
       .flatMap(_.split(',').toList)
   } yield Task(
     specsInput = specs,
     config = GeneratorConfig(
       outDir = outDir,
-      resourcesPkg = resourcesPkg,
-      schemasPkg = schemasPkg,
+      outPkg = outPkg,
       httpSource = httpSource,
       jsonCodec = jsonCodec,
       dialect = Dialect.Scala3,