Deprecate --src and --sources to disambiguate with --source compiler option (#3412)

* Deprecate `--src`

* Deprecate `--sources`

* Deprecate `--sources` in publish

* Add `--jar-sources` and `--sources-jar` aliases for publish, to match package

* Remove deprecated `--sources` references in tests

Author: Gedochao

modules/cli/src/main/scala/scala/cli/commands/package0/PackageOptions.scala

@@ -51,9 +51,12 @@ final case class PackageOptions(
   @Name("sourcesJar")
   @Name("jarSources")
   @Name("sources")
+  @Tag(tags.deprecated("sources"))
+  @Name("src")
+  @Tag(tags.deprecated("src"))
   @Tag(tags.restricted)
   @Tag(tags.inShortHelp)
-    src: Boolean = false,
+    withSources: Boolean = false,
   @Group(HelpGroup.Package.toString)
   @HelpMessage("Generate a scaladoc JAR rather than an executable JAR")
   @ExtraName("scaladoc")
@@ -145,7 +148,7 @@ final case class PackageOptions(
   def packageTypeOpt: Option[PackageType] =
     forcedPackageTypeOpt.orElse {
       if (library) Some(PackageType.LibraryJar)
-      else if (src) Some(PackageType.SourceJar)
+      else if (withSources) Some(PackageType.SourceJar)
       else if (assembly) Some(
         PackageType.Assembly(
           addPreamble = preamble,

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

@@ -104,7 +104,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
     val contextualOptions = PublishContextualOptions(
       repository = publishRepo.publishRepository.filter(_.trim.nonEmpty),
       repositoryIsIvy2LocalLike = ivy2LocalLike,
-      sourceJar = sharedPublish.sources,
+      sourceJar = sharedPublish.withSources,
       docJar = sharedPublish.doc,
       gpgSignatureId = sharedPublish.gpgKey.map(_.trim).filter(_.nonEmpty),
       gpgOptions = sharedPublish.gpgOption,

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

@@ -30,9 +30,13 @@ final case class SharedPublishOptions(
 
   @Group(HelpGroup.Publishing.toString)
   @HelpMessage("Whether to build and publish source JARs")
+  @Name("sourcesJar")
+  @Name("jarSources")
+  @Name("sources")
+  @Tag(tags.deprecated("sources"))
   @Tag(tags.restricted)
   @Tag(tags.inShortHelp)
-    sources: Option[Boolean] = None,
+    withSources: Option[Boolean] = None,
 
   @Group(HelpGroup.Publishing.toString)
   @HelpMessage("Whether to build and publish doc JARs")

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

@@ -1712,7 +1712,7 @@ abstract class BspTestDefinitions extends ScalaCliSuite with TestScalaVersionArg
         "--power",
         "package",
         jarSources,
-        "--src",
+        "--with-sources",
         "-o",
         sourceJarPath,
         extraOptions

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

@@ -869,7 +869,7 @@ abstract class PackageTestDefinitions extends ScalaCliSuite with TestScalaVersio
   test("source JAR") {
     val dest = os.rel / "sources.jar"
     simpleInputWithScalaAndSc.fromRoot { root =>
-      os.proc(TestUtil.cli, "--power", "package", extraOptions, ".", "-o", dest, "--src").call(
+      os.proc(TestUtil.cli, "--power", "package", extraOptions, ".", "-o", dest, "--with-sources").call(
         cwd = root,
         stdin = os.Inherit,
         stdout = os.Inherit

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

@@ -320,7 +320,7 @@ abstract class PublishTestDefinitions extends ScalaCliSuite with TestScalaVersio
         "--power",
         "publish",
         extraOptions,
-        "--sources=false",
+        "--with-sources=false",
         "--doc=false",
         "--checksum",
         "sha-1",

website/docs/reference/cli-options.md

@@ -779,9 +779,9 @@ Overwrite the destination file, if it exists
 
 Generate a library JAR rather than an executable JAR
 
-### `--src`
+### `--with-sources`
 
-Aliases: `--jar-sources`, `--sources`, `--sources-jar`
+Aliases: `--jar-sources`, [deprecated] `--sources`, `--sources-jar`, [deprecated] `--src`
 
 Generate a source JAR rather than an executable JAR
 
@@ -1035,7 +1035,9 @@ Scala version suffix to append to the module name, like "_2.13" or "_3"
 [Internal]
 Scala platform suffix to append to the module name, like "_sjs1" or "_native0.4"
 
-### `--sources`
+### `--with-sources`
+
+Aliases: `--jar-sources`, [deprecated] `--sources`, `--sources-jar`
 
 Whether to build and publish source JARs