Skip to content

Add some explanations on implicit sub-commands in -help #1587

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 17, 2022
Merged

Add some explanations on implicit sub-commands in -help #1587

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions modules/cli/src/main/scala/scala/cli/commands/default/Default.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,20 @@ class Default(
isSipScala: Boolean
) extends ScalaCommand[DefaultOptions] {

private def defaultHelp: String = actualHelp.help(ScalaCliHelp.helpFormat)
private def defaultFullHelp: String = actualHelp.help(ScalaCliHelp.helpFormat, showHidden = true)
private lazy val defaultCommandHelp: String =
s"""
|
|When no subcommand is passed explicitly, an implicit subcommand is used based on context:
| - if the '--version' option is passed, it prints the 'version' subcommand output, unmodified by any other options
| - if any inputs were passed, it defaults to the 'run' subcommand
| - additionally, when no inputs were passed, it defaults to the 'run' subcommand in the following scenarios:
| - if a snippet was passed with any of the '--execute*' options
| - if a main class was passed with the '--main-class' option alongside an extra '--classpath'
| - otherwise, if no inputs were passed, it defaults to the 'repl' subcommand""".stripMargin

private def defaultHelp: String = actualHelp.help(ScalaCliHelp.helpFormat) + defaultCommandHelp
private def defaultFullHelp: String =
actualHelp.help(ScalaCliHelp.helpFormat, showHidden = true) + defaultCommandHelp

override def group = "Main"
override def sharedOptions(options: DefaultOptions): Option[SharedOptions] = Some(options.shared)
Expand Down