Refactor computeVersion and version to a separate option class

Author: MaciejG604

modules/cli/src/main/scala/scala/cli/commands/publish/Publish.scala

@@ -50,7 +50,8 @@ import scala.cli.commands.shared.{
   HelpGroup,
   MainClassOptions,
   SharedOptions,
-  SharedPythonOptions
+  SharedPythonOptions,
+  SharedVersionOptions
 }
 import scala.cli.commands.util.{BuildCommandHelpers, ScalaCliSttpBackend}
 import scala.cli.commands.{ScalaCommand, SpecificationLevel, WatchUtil}
@@ -85,6 +86,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
 
   def mkBuildOptions(
     baseOptions: BuildOptions,
+    sharedVersionOptions: SharedVersionOptions,
     publishParams: PublishParamsOptions,
     sharedPublish: SharedPublishOptions,
     publishRepo: PublishRepositoryOptions,
@@ -111,7 +113,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
           .sequence
       },
       computeVersion = value {
-        publishParams.computeVersion
+        sharedVersionOptions.computeVersion
           .map(Positioned.commandLine)
           .map(ComputeVersion.parse)
           .sequence
@@ -132,7 +134,9 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
           moduleName =
             publishParams.moduleName.map(_.trim).filter(_.nonEmpty).map(Positioned.commandLine),
           version =
-            publishParams.version.map(_.trim).filter(_.nonEmpty).map(Positioned.commandLine),
+            sharedVersionOptions.projectVersion.map(_.trim).filter(_.nonEmpty).map(
+              Positioned.commandLine
+            ),
           url = publishParams.url.map(_.trim).filter(_.nonEmpty).map(Positioned.commandLine),
           license = value {
             publishParams.license
@@ -203,6 +207,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
 
     val initialBuildOptions = mkBuildOptions(
       baseOptions,
+      options.shared.sharedVersionOptions,
       options.publishParams,
       options.sharedPublish,
       options.publishRepo,

modules/cli/src/main/scala/scala/cli/commands/publish/PublishLocal.scala

@@ -40,6 +40,7 @@ object PublishLocal extends ScalaCommand[PublishLocalOptions] {
 
     val initialBuildOptions = Publish.mkBuildOptions(
       baseOptions,
+      options.shared.sharedVersionOptions,
       options.publishParams,
       options.sharedPublish,
       PublishRepositoryOptions(),

modules/cli/src/main/scala/scala/cli/commands/publish/PublishParamsOptions.scala

@@ -2,7 +2,7 @@ package scala.cli.commands.publish
 
 import caseapp.*
 
-import scala.cli.commands.shared.HelpGroup
+import scala.cli.commands.shared.{HelpGroup, SharedVersionOptions}
 import scala.cli.commands.tags
 import scala.cli.signing.shared.PasswordOption
 import scala.cli.signing.util.ArgParsers.*
@@ -11,7 +11,6 @@ import scala.cli.util.MaybeConfigPasswordOption
 
 // format: off
 final case class PublishParamsOptions(
-
   @Group(HelpGroup.Publishing.toString)
   @HelpMessage("Organization to publish artifacts under")
   @Tag(tags.restricted)
@@ -28,15 +27,6 @@ final case class PublishParamsOptions(
   @Tag(tags.inShortHelp)
     moduleName: Option[String] = None,
   @Group(HelpGroup.Publishing.toString)
-  @HelpMessage("Version to publish artifacts as")
-  @Tag(tags.restricted)
-  @Tag(tags.inShortHelp)
-    version: Option[String] = None,
-  @Group(HelpGroup.Publishing.toString)
-  @HelpMessage("How to compute the version to publish artifacts as")
-  @Tag(tags.restricted)
-    computeVersion: Option[String] = None,
-  @Group(HelpGroup.Publishing.toString)
   @HelpMessage("URL to put in publishing metadata")
   @Tag(tags.restricted)
   @Tag(tags.inShortHelp)

modules/cli/src/main/scala/scala/cli/commands/publish/PublishSetupOptions.scala

@@ -15,6 +15,8 @@ final case class PublishSetupOptions(
     global: GlobalOptions = GlobalOptions(),
   @Recurse
     coursier: CoursierOptions = CoursierOptions(),
+  @Recurse
+    sharedVersionOptions: SharedVersionOptions = SharedVersionOptions(),
   @Recurse
     workspace: SharedWorkspaceOptions = SharedWorkspaceOptions(),
   @Recurse

modules/cli/src/main/scala/scala/cli/commands/publish/checks/ComputeVersionCheck.scala

@@ -29,7 +29,7 @@ final case class ComputeVersionCheck(
       }
       else
         None
-    val cv = options.publishParams.computeVersion
+    val cv = options.sharedVersionOptions.computeVersion
       .orElse(fromGitOpt)
     cv.map(OptionCheck.DefaultValue.simple(_, Nil, Nil)).toRight {
       new MissingPublishOptionError(

modules/cli/src/main/scala/scala/cli/commands/shared/HelpGroups.scala

@@ -12,7 +12,7 @@ enum HelpGroup:
     Launcher, LegacyScalaRunner, Logging,
     MacOS, Markdown,
     NativeImage,
-    Package, PGP, Publishing,
+    Package, PGP, ProjectVersion, Publishing,
     RedHat, Repl, Run, Runner,
     Scala, ScalaJs, ScalaNative, Secret, Signing, SuppressWarnings, SourceGenerator,
     Test,
@@ -29,6 +29,7 @@ enum HelpGroup:
     case ScalaNative       => "Scala Native"
     case SuppressWarnings  => "Suppress warnings"
     case SourceGenerator   => "Source generator"
+    case ProjectVersion    => "Project version"
     case e                 => e.productPrefix
 
 enum HelpCommandGroup:

modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala

@@ -52,6 +52,8 @@ import scala.util.control.NonFatal
 
 // format: off
 final case class SharedOptions(
+  @Recurse
+    sharedVersionOptions: SharedVersionOptions = SharedVersionOptions(),
   @Recurse
     sourceGenerator: SourceGeneratorOptions = SourceGeneratorOptions(),
   @Recurse
@@ -319,7 +321,7 @@ final case class SharedOptions(
       sourceGeneratorOptions = bo.SourceGeneratorOptions(
         useBuildInfo = sourceGenerator.useBuildInfo,
         computeVersion = value {
-          sourceGenerator.computeVersion
+          sharedVersionOptions.computeVersion
             .map(Positioned.commandLine)
             .map(ComputeVersion.parse)
             .sequence

modules/cli/src/main/scala/scala/cli/commands/shared/SharedVersionOptions.scala

@@ -0,0 +1,26 @@
+package scala.cli.commands.shared
+
+import caseapp.*
+
+import scala.cli.commands.tags
+
+// format: off
+final case class SharedVersionOptions(
+  @Group(HelpGroup.ProjectVersion.toString)
+  @HelpMessage("Method used to compute the project version")
+  @ValueDescription("git|git:tag|command:...")
+  @Tag(tags.restricted)
+  @Tag(tags.inShortHelp)
+    computeVersion: Option[String] = None,
+  @Group(HelpGroup.ProjectVersion.toString)
+  @HelpMessage("Set the project version")
+  @Tag(tags.restricted)
+  @Tag(tags.inShortHelp)
+    projectVersion: Option[String] = None
+)
+// format: on
+
+object SharedVersionOptions {
+  implicit lazy val parser: Parser[SharedVersionOptions] = Parser.derive
+  implicit lazy val help: Help[SharedVersionOptions]     = Help.derive
+}

modules/cli/src/main/scala/scala/cli/commands/shared/SourceGeneratorOptions.scala

@@ -7,13 +7,10 @@ import scala.cli.commands.tags
 // format: off
 final case class SourceGeneratorOptions(
   @Group(HelpGroup.SourceGenerator.toString)
-  @Tag(tags.experimental)
+  @Tag(tags.restricted)
   @HelpMessage("Generate BuildInfo for project")
   @Name("buildInfo")
-    useBuildInfo: Option[Boolean] = None,
-  @HelpMessage("Method used to compute the project version for BuildInfo")
-  @Tag(tags.experimental)
-    computeVersion: Option[String] = None,
+    useBuildInfo: Option[Boolean] = None
 )
 // format: on
 

modules/integration/src/test/scala/scala/cli/integration/ConfigTests.scala

@@ -408,7 +408,7 @@ class ConfigTests extends ScalaCliSuite {
         testOrg,
         "--name",
         testName,
-        "--version",
+        "--project-version",
         testVersion
       )
         .call(cwd = root, stdin = os.Inherit, stdout = os.Inherit, env = extraEnv)