Apply review comments

- temporarily remove console-specific characters from help messages to fix the reference doc website
- remove redundant tags for options already tagged as `SpecificationLevel.MUST`
- rename `tags.important` to `tags.inShortHelp`

modules/cli/src/main/scala/scala/cli/commands/compile/CompileOptions.scala

@@ -27,13 +27,13 @@ final case class CompileOptions(
   @Name("printClasspath")
   @HelpMessage("Print the resulting class path")
   @Tag(tags.should)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     printClassPath: Boolean = false,
 
   @Group("Compilation")
   @HelpMessage("Compile test scope")
   @Tag(tags.should)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     test: Boolean = false
 ) extends HasSharedOptions
   // format: on

modules/cli/src/main/scala/scala/cli/commands/config/ConfigOptions.scala

@@ -29,53 +29,53 @@ final case class ConfigOptions(
   @HelpMessage("Dump config DB as JSON")
   @Hidden
   @Tag(tags.implementation)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     dump: Boolean = false,
   @Group("Config")
   @HelpMessage("Create PGP key in config")
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @Tag(tags.restricted)
     createPgpKey: Boolean = false,
   @Group("Config")
   @HelpMessage("Email to use to create PGP key in config")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     email: Option[String] = None,
   @Group("Config")
   @HelpMessage("If the entry is a password, print the password value rather than how to get the password")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     password: Boolean = false,
   @Group("Config")
   @HelpMessage("If the entry is a password, save the password value rather than how to get the password")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     passwordValue: Boolean = false,
   @Group("Config")
   @HelpMessage("Remove an entry from config")
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @Tag(tags.should)
   @ExtraName("remove")
     unset: Boolean = false,
   @Group("Config")
   @HelpMessage("For repository.credentials and publish.credentials, whether these credentials should be HTTPS only (default: true)")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     httpsOnly: Option[Boolean] = None,
   @Group("Config")
   @HelpMessage("For repository.credentials, whether to use these credentials automatically based on the host")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     matchHost: Option[Boolean] = None,
   @Group("Config")
   @HelpMessage("For repository.credentials, whether to use these credentials are optional")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     optional: Option[Boolean] = None,
   @Group("Config")
   @HelpMessage("For repository.credentials, whether to use these credentials should be passed upon redirection")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     passOnRedirect: Option[Boolean] = None
 ) extends HasLoggingOptions
 // format: on

modules/cli/src/main/scala/scala/cli/commands/dependencyupdate/DependencyUpdateOptions.scala

@@ -14,7 +14,7 @@ final case class DependencyUpdateOptions(
   @Group("Dependency")
   @HelpMessage("Update all dependencies if a newer version was released")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     all: Boolean = false,
 ) extends HasSharedOptions
   // format: on

modules/cli/src/main/scala/scala/cli/commands/export0/ExportOptions.scala

@@ -17,12 +17,12 @@ final case class ExportOptions(
 
   @Group("Build Tool export")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @HelpMessage("Sets the export format to SBT")
     sbt: Option[Boolean] = None,
   @Group("Build Tool export")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @HelpMessage("Sets the export format to Mill")
     mill: Option[Boolean] = None,
   @Tag(tags.restricted)

modules/cli/src/main/scala/scala/cli/commands/fmt/FmtOptions.scala

@@ -20,7 +20,7 @@ final case class FmtOptions(
 
   @Group("Format")
   @Tag(tags.should)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @HelpMessage("Check if sources are well formatted")
     check: Boolean = false,
 
@@ -31,7 +31,7 @@ final case class FmtOptions(
 
   @Group("Format")
   @Tag(tags.implementation)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @HelpMessage("Saves .scalafmt.conf file if it was created or overwritten")
     saveScalafmtConf: Boolean = false,
 
@@ -60,13 +60,13 @@ final case class FmtOptions(
   @Name("F")
   @Tag(tags.implementation)
   @HelpMessage("Pass an argument to scalafmt.")
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     scalafmtArg: List[String] = Nil,
 
   @Group("Format")
   @HelpMessage("Custom path to the scalafmt configuration file.")
   @Tag(tags.implementation)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @Name("scalafmtConfig")
     scalafmtConf: Option[String] = None,
   @Group("Format")
@@ -80,13 +80,13 @@ final case class FmtOptions(
   @HelpMessage("Pass a global dialect for scalafmt. This overrides whatever value is configured in the .scalafmt.conf file or inferred based on Scala version used.")
   @Tag(tags.implementation)
   @Name("dialect")
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     scalafmtDialect: Option[String] = None,
   @Tag(tags.implementation)
   @Group("Format")
   @HelpMessage(s"Pass scalafmt version before running it (${Constants.defaultScalafmtVersion} by default). If passed, this overrides whatever value is configured in the .scalafmt.conf file.")
   @Name("fmtVersion")
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     scalafmtVersion: Option[String] = None
 ) extends HasSharedOptions {
   // format: on

modules/cli/src/main/scala/scala/cli/commands/github/SecretCreateOptions.scala

@@ -18,7 +18,7 @@ final case class SecretCreateOptions(
     coursier: CoursierOptions = CoursierOptions(),
   @Group("Secret")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @ExtraName("pubKey")
     publicKey: Option[String] = None,
   @Tag(tags.implementation)

modules/cli/src/main/scala/scala/cli/commands/github/SharedSecretOptions.scala

@@ -13,12 +13,12 @@ final case class SharedSecretOptions(
     logging: LoggingOptions = LoggingOptions(),
   @Group("Secret")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     token: PasswordOption = PasswordOption.Value(Secret("")),
   @ExtraName("repo")
   @Group("Secret")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     repository: String = ""
 ) extends HasLoggingOptions {
   // format: on

modules/cli/src/main/scala/scala/cli/commands/installcompletions/InstallCompletionsOptions.scala

@@ -14,13 +14,13 @@ final case class InstallCompletionsOptions(
   @Group("Install")
   @Name("shell")
   @Tag(tags.implementation)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @HelpMessage("Name of the shell, either zsh or bash")
     format: Option[String] = None,
 
   @Tag(tags.implementation)
   @Group("Install")
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
   @HelpMessage("Path to `*rc` file, defaults to `.bashrc` or `.zshrc` depending on shell")
   rcFile: Option[String] = None,
 

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

@@ -32,41 +32,41 @@ final case class PackageOptions(
   @HelpMessage("Set the destination path")
   @Name("o")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     output: Option[String] = None,
   @Group("Package")
   @HelpMessage("Overwrite the destination file, if it exists")
   @Name("f")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     force: Boolean = false,
 
   @Group("Package")
   @HelpMessage("Generate a library JAR rather than an executable JAR")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     library: Boolean = false,
   @Group("Package")
   @HelpMessage("Generate a source JAR rather than an executable JAR")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     source: Boolean = false,
   @Group("Package")
   @HelpMessage("Generate a scaladoc JAR rather than an executable JAR")
   @ExtraName("scaladoc")
   @ExtraName("javadoc")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     doc: Boolean = false,
   @Group("Package")
   @HelpMessage("Generate an assembly JAR")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     assembly: Boolean = false,
   @Group("Package")
   @HelpMessage("For assembly JAR, whether to add a bash / bat preamble")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     preamble: Boolean = true,
   @Group("Package")
   @Hidden
@@ -81,47 +81,47 @@ final case class PackageOptions(
   @Group("Package")
   @HelpMessage("Package standalone JARs")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     standalone: Option[Boolean] = None,
   @Recurse
     packager: PackagerOptions = PackagerOptions(),
   @Group("Package")
   @HelpMessage("Build Debian package, available only on Linux")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     deb: Boolean = false,
   @Group("Package")
   @HelpMessage("Build dmg package, available only on macOS")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     dmg: Boolean = false,
   @Group("Package")
   @HelpMessage("Build rpm package, available only on Linux")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     rpm: Boolean = false,
   @Group("Package")
   @HelpMessage("Build msi package, available only on Windows")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     msi: Boolean = false,
   @Group("Package")
   @HelpMessage("Build pkg package, available only on macOS")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     pkg: Boolean = false,
   @Group("Package")
   @HelpMessage("Build Docker image")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     docker: Boolean = false,
 
   @Group("Package")
   @Hidden
   @HelpMessage("Exclude modules *and their transitive dependencies* from the JAR to be packaged")
   @ValueDescription("org:name")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     provided: List[String] = Nil,
 
   @Group("Package")
@@ -134,7 +134,7 @@ final case class PackageOptions(
   @HelpMessage("Build GraalVM native image")
   @ExtraName("graal")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     nativeImage: Boolean = false
 ) extends HasSharedOptions {
   // format: on

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

@@ -136,12 +136,12 @@ final case class PackagerOptions(
   @HelpMessage(s"GraalVM Java major version to use to build GraalVM native images (${Constants.defaultGraalVMJavaVersion} by default)")
   @ValueDescription("java-major-version")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     graalvmJavaVersion: Option[Int] = None,
   @Group("Native image")
   @HelpMessage(s"GraalVM version to use to build GraalVM native images (${Constants.defaultGraalVMVersion} by default)")
   @ValueDescription("version")
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     graalvmVersion: Option[String] = None,
   @Group("Native image")
   @HelpMessage("JVM id of GraalVM distribution to build GraalVM native images (like \"graalvm-java17:22.0.0\")")

modules/cli/src/main/scala/scala/cli/commands/pgp/SharedPgpPushPullOptions.scala

@@ -13,7 +13,7 @@ final case class SharedPgpPushPullOptions(
   @HelpMessage("Key server to push / pull keys from")
   @ValueDescription("URL")
   @Tag(tags.restricted)
-  @Tag(tags.important)
+  @Tag(tags.inShortHelp)
     keyServer: List[String] = Nil
 ) {
   // format: on