scala-cli icon indicating copy to clipboard operation
scala-cli copied to clipboard

Scala CLI help should provide a way to display help from compiler, REPL and other undelaying tools

Open romanowski opened this issue 2 years ago • 2 comments

Is your feature request related to a problem? Please describe.

Scala CLI is intended to be a replacement for many tools like compiler, REPL and scalafmt. That is why we should allow our users a way to inspect the help from underlying tools as well. Also a help message for each such tool should mention about different such options.

Describe the solution you'd like

A dedicated flag e.g. --help-repl or --help-scalac to display a help from underlying tool.

romanowski avatar Aug 30 '22 15:08 romanowski

@romanowski We already have a flag for viewing help from the compiler: --scalac-help

▶ scala-cli --scalac-help
Usage: scalac <options> <source files>
where possible standard options include:
     -Dproperty=value  Pass -Dproperty=value directly to the runtime system.
             -J<flag>  Pass <flag> directly to the runtime system.
                   -P  Pass an option to a plugin, e.g. -P:<plugin>:<opt>
                   -V  Print a synopsis of verbose options.
                   -W  Print a synopsis of warning options.
               -Wconf  Configure compiler warnings.
              -Werror  Fail the compilation if there are any warnings.
                   -X  Print a synopsis of advanced options.
                   -Y  Print a synopsis of private options.
       (...)

I can add --help-scalac as an alias, if necessary.

Gedochao avatar Aug 31 '22 07:08 Gedochao

Ah, you are right. However, scala-cli compile --help does not suggest that it should be used so maybe we just need to add just this.

romanowski avatar Aug 31 '22 08:08 romanowski