Descriptive.Options

Command-line options parser.

Combinators

anyString :: Text -> Consumer [Text] (Option a) Text

Consume one argument from the argument list and pops it from the start of the list.

constant

Arguments

:: Text

String.

-> Text

Description.

-> Consumer [Text] (Option a) Text

Consume one argument from the argument list which must match the given string.

flag

Arguments

:: Text

Name.

-> Text

Description.

-> v

Value returned when present.

-> Consumer [Text] (Option a) v

Find a value flag which must succeed.

switch

Arguments

:: Text

Name.

-> Text

Description.

-> Consumer [Text] (Option a) Bool

Find a boolean flag. Always succeeds. Omission counts as False.

prefix

Arguments

:: Text

Prefix string.

-> Text

Description.

-> Consumer [Text] (Option a) Text

Find an argument prefixed by -X.

arg

Arguments

:: Text

Name.

-> Text

Description.

-> Consumer [Text] (Option a) Text

Find a named argument e.g. --name value.

stop

Arguments

:: Consumer [Text] (Option a) a

A parser which, when it succeeds, causes the whole parser to stop.

-> Consumer [Text] (Option a) ()

If the consumer succeeds, stops the whole parser and returns immediately.

Description

data Option a

Description of a commandline option.

Constructors

AnyString !Text

Constant !Text !Text

Flag !Text !Text

Arg !Text !Text

Prefix !Text !Text

Stops

Stopped !a

Instances

Eq a => Eq (Option a)

Show a => Show (Option a)

textDescription :: Description (Option a) -> Text

Make a text description of the command line options.

textOpt :: Option a -> Text

Make a text description of an option.