scala-cli
scala-cli copied to clipboard
The default scala version should be displayed in the help of the relevant subcommands
Is your feature request related to a problem? Please describe.
The default value of the scala version should be communicated in the output of --help for the relevant subcommands as well as in the published documentation.
For example:
$> scala-cli compile --help | grep scala-version
-S, --scala, --scala-version version Set the Scala version
Describe the solution you'd like
The default scala version is displayed in the output of --help for all of the subcommands that have --scala-version as a flag.
$> scala-cli compile --help | grep scala-version
-S, --scala, --scala-version version Set the Scala version (default: 3.1.2)
Ideally, the default values of the directives in the docs should be consistent with the --help output.
https://scala-cli.virtuslab.org/docs/reference/directives#scala-version
Additional context
I believe this improvement could benefit other command flags (e.g., --jvm) as well. Clearly communicating the default values in --help would improve visibility into what scala-cli is doing under the hood and improve the overall user experience, specifically for new scala users.