case-app
API
Generated with
case-app/caseapp/caseapp.core/caseapp.core.help

caseapp.core.help

package caseapp.core.help

Members list

Type members

Classlikes

case class CommandHelp(args: Seq[Arg], argsNameOption: Option[String], helpMessage: Option[HelpMessage])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Help[T](args: Seq[Arg], appName: String, appVersion: String, progName: String, argsNameOption: Option[String], optionsDesc: String, nameFormatter: Formatter[Name], helpMessage: Option[HelpMessage])

Provides usage and help messages related to T

Provides usage and help messages related to T

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Help extends HelpCompanion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
Help.type
object HelpCompanion

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class HelpCompanion

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Help.type
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], filterArgs: Option[Arg => Boolean], filterArgsWhenShowHidden: Option[Arg => Boolean], hiddenGroupsWhenShowHidden: Option[Seq[String]], namesLimit: Option[Int])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HelpFormat

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
HelpFormat.type
object PlatformUtil

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class RuntimeCommandHelp[T](names: List[List[String]], help: Help[T], group: String, hidden: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RuntimeCommandsHelp(progName: String, description: Option[String], defaultHelp: Help[_], commands: Seq[RuntimeCommandHelp[_]], summaryDesc: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Table(lines: IndexedSeq[Seq[Str]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class WithFullHelp[+T](withHelp: WithHelp[T], helpFull: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WithFullHelp extends WithFullHelpCompanion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
abstract class WithFullHelpCompanion

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object WithFullHelp.type
final case class WithHelp[+T](usage: Boolean, help: Boolean, baseOrError: Either[Error, T])

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 T in case of success, or error message else

help:

whether help was requested

usage:

whether usage was requested

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WithHelp extends WithHelpCompanion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
WithHelp.type
abstract class WithHelpCompanion

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object WithHelp.type
object WordUtils

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
WordUtils.type
Generated with