Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
romanowski opened this issue Aug 30, 2022 · 2 comments · Fixed by #1487
Assignees
Labels
SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.

Comments

@romanowski
Copy link
Member

romanowski commented Aug 30, 2022

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 romanowski added the SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command. label Aug 30, 2022
@Gedochao
Copy link
Contributor

@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.

@romanowski
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants