caseapp.core.help
package caseapp.core.help
Type members
Classlikes
case class CommandHelp(args: Seq[Arg], argsNameOption: Option[String], helpMessage: Option[HelpMessage])
Provides usage and help messages related to T
Provides usage and help messages related to T
- Companion:
- object
case class HelpFormat(progName: Attrs, commandName: Attrs, option: Attrs, newLine: String, sortGroups: Option[Seq[String] => Seq[String]], sortedGroups: Option[Seq[String]], hiddenGroups: Option[Seq[String]], sortCommandGroups: Option[Seq[String] => Seq[String]], sortedCommandGroups: Option[Seq[String]], hidden: Attrs, terminalWidthOpt: Option[Int])
- Companion:
- object
case class RuntimeCommandsHelp(progName: String, description: Option[String], defaultHelp: Help[_], commands: Seq[RuntimeCommandHelp[_]], summaryDesc: Option[String])
Helper to add --usage and --help options to an existing type T.
Helper to add --usage and --help options to an existing type T.
- Type parameters:
- T:
type to which usage and help options are added
- Value parameters:
- baseOrError:
parsed
Tin case of success, or error message else- help:
whether help was requested
- usage:
whether usage was requested
- Companion:
- object