clipp-core/io.github.vigoo.clipp/syntax

syntax

trait syntax
Companion:
object
class Object
trait Matchable
class Any
object syntax.type

Value members

Concrete methods

def command(validValues: String*): Spec[String]
def command(validValues: List[String], withDocumentedChoices: List[String]): Spec[String]
def fail[E : CustomParserError, T](failure: E): Spec[T]
def flag(description: String, shortName: Char, longNames: String*): Free[Parameter, Boolean]
def flag(description: String, longName: String, otherLongNames: String*): Free[Parameter, Boolean]
def flag(description: String, shortName: Char, longNames: List[String], withDocumentedChoices: List[Boolean]): Free[Parameter, Boolean]
def lift[T](description: String, examples: NonEmptyList[T])(f: => T): Spec[T]
def lift[T](description: String, example: T)(f: => T): Spec[T]
def liftEither[E : CustomParserError, T](description: String, examples: NonEmptyList[T])(f: => Either[E, T]): Spec[T]
def liftEither[E : CustomParserError, T](description: String, example: T)(f: => Either[E, T]): Spec[T]
def liftTry[T](description: String, examples: NonEmptyList[T])(f: => Try[T]): Spec[T]
def liftTry[T](description: String, example: T)(f: => Try[T]): Spec[T]
def metadata(programName: String): Spec[Unit]
def metadata(programName: String, description: String): Spec[Unit]
def namedParameter[T : ParameterParser](description: String, placeholder: String, shortName: Char, longNames: String*): Spec[T]
def namedParameter[T : ParameterParser](description: String, placeholder: String, shortName: Char, longNames: List[String], withDocumentedChoices: List[T]): Spec[T]
def namedParameter[T : ParameterParser](description: String, placeholder: String, longName: String, otherLongNames: String*): Spec[T]
def namedParameter[T : ParameterParser](description: String, placeholder: String, longName: String, otherLongNames: List[String], withDocumentedChoices: List[T]): Spec[T]
def optional[T](parameter: Spec[T]): Spec[Option[T]]
def parameter[T : ParameterParser](description: String, placeholder: String): Spec[T]
def parameter[T : ParameterParser](description: String, placeholder: String, withDocumentedChoices: List[T]): Spec[T]
def pure[T](value: T): Spec[T]
def repeated[T](parameter: Spec[T]): Spec[List[T]]