core

Core types / classes of caseapp.

Not that in most use cases of caseapp, simply importing things right under caseapp, rather things from caseapp.core, should be enough.

This package is itself split in several sub-packages:

caseapp.core.argparser: things related to parsing a single argument value,
caseapp.core.parser: things related to parsing a sequence of arguments,
caseapp.core.commandparser: things related to parsing a sequence of arguments, handling commands,
caseapp.core.help: things related to help messages,
caseapp.core.app: helpers to create caseapp-based applications,
caseapp.core.default: helper to set / define a default value for a given type,
caseapp.core.util: utilities, mostly for internal use.

Linear Supertypes

Ordering

Inherited

Visibility

package app
package argparser
Things related to parsing a single argument.
Things related to parsing a single argument.
Mostly revolves around caseapp.core.argparser.ArgParser.
package commandparser
Command parsing-related things.
package complete
package default
package help
package parser
All-the-arguments parsing stuff.
All-the-arguments parsing stuff.
Mostly revolves around caseapp.core.parser.Parser.
package util

final case class Arg(name: Name, extraNames: Seq[Name], valueDescription: Option[ValueDescription], helpMessage: Option[HelpMessage], noHelp: Boolean, isFlag: Boolean, group: Option[Group], origin: Option[String], tags: Seq[Tag]) extends Product with Serializable
Infos about an argument / option an application can accept.
sealed abstract class Counter extends AnyRef
Helper to count how many times a flag argument is specified.
Helper to count how many times a flag argument is specified.
Should be used with Int and caseapp.@@, like Int @@ Counter.
sealed abstract class Error extends Product with Serializable
Base type for errors during arguments parsing
final case class Indexed[+T](index: Int, length: Int, value: T) extends Product with Serializable
final case class RemainingArgs(indexedRemaining: Seq[Indexed[String]], indexedUnparsed: Seq[Indexed[String]]) extends Product with Serializable
Arguments that don't correspond to options.

Packages