clipp-core/io.github.vigoo.clipp

io.github.vigoo.clipp

package io.github.vigoo.clipp

Type members

Classlikes

trait ClippIO[F[_]]
Companion:
object
object ClippIO
Companion:
class
trait ClippImpl[F[_]]
case class Command(validCommands: List[String], explicitChoices: Option[List[String]]) extends Parameter[String]
case class Fail[T](message: String) extends Parameter[T]
case class Flag(shortName: Option[Char], longNames: Set[String], description: String, explicitChoices: Option[List[Boolean]]) extends Parameter[Boolean]
case class Lift[T](f: () => Either[String, T], description: String, examples: NonEmptyList[T]) extends Parameter[T]
case class NamedParameter[T](shortName: Option[Char], longNames: Set[String], placeholder: String, description: String, explicitChoices: Option[List[T]], parameterParser: ParameterParser[T]) extends Parameter[T]
case class Optional[T](parameter: Spec[T]) extends Parameter[Option[T]]
sealed trait Parameter[T]
Companion:
object
object Parameter
Companion:
class
trait ParameterParser[T]

Type class for parsing a command line argument to type T

Type class for parsing a command line argument to type T

case class ParameterParserMetadata(programName: String, description: Option[String])
object Parser
case class ParserFailure(errors: NonEmptyList[ParserError], partialChoices: Choices, spec: Free[Parameter, _])
case class SetMetadata(metadata: ParameterParserMetadata) extends Parameter[Unit]
case class SimpleParameter[T](placeholder: String, description: String, explicitChoices: Option[List[T]], parameterParser: ParameterParser[T]) extends Parameter[T]
trait VersionSpecificParsers
object choices
object errors
object parsers extends VersionSpecificParsers
trait syntax
Companion:
object
object syntax extends syntax
Companion:
class