Console.Options

Running

defaultMain :: OptionDesc (IO ()) () -> IO ()

defaultMainWith :: OptionDesc (IO ()) () -> [String] -> IO ()

parseOptions :: OptionDesc r () -> [String] -> (ProgramDesc r, OptionRes r)

data OptionRes r

Constructors

OptionSuccess Params (Action r)

OptionHelp

OptionError String

OptionInvalid String

data OptionDesc r a

Instances

Monad (OptionDesc r)

Functor (OptionDesc r)

Applicative (OptionDesc r)

Description

programName :: String -> OptionDesc r ()

Set the program name

programVersion :: Version -> OptionDesc r ()

Set the program version

programDescription :: String -> OptionDesc r ()

Set the program description

command :: String -> OptionDesc r () -> OptionDesc r ()

Create a new sub command

data FlagFrag

Constructors

FlagShort Char

FlagLong String

FlagDescription String

Instances

Eq FlagFrag

Show FlagFrag

Monoid FlagFrag

flag :: FlagFrag -> OptionDesc r (Flag Bool)

Flag option either of the form -short or --long

for flag that expect a value (optional or mandatory), uses flagArg

flagParam :: FlagFrag -> FlagParser a -> OptionDesc r (FlagParam a)

Flag option either of the form -short or --long

for flag that doesn't have parameter, use flag

flagMany :: OptionDesc r (FlagParam a) -> OptionDesc r (FlagMany a)

conflict :: Flag a -> Flag b -> OptionDesc r ()

give the ability to set options that are conflicting with each other if option a is given with option b then an conflicting error happens

argument :: String -> ValueParser a -> OptionDesc r (Arg a)

An unnamed argument

For now, argument in a point of tree that contains sub trees will be ignored. TODO: record a warning or add a strict mode (for developping the CLI) and error.

remainingArguments :: String -> OptionDesc r (ArgRemaining [String])

action :: Action r -> OptionDesc r ()

Set the action to run in this command

description :: String -> OptionDesc r ()

Set the description for a command

type Action r = (forall a p. Param p => p a -> Ret p a) -> r

Represent a program to run

Arguments

data FlagParser a

Constructors

FlagRequired (ValueParser a)

FlagOptional a (ValueParser a)

data Flag a

data FlagLevel a

data FlagParam a

data FlagMany a

data Arg a

data ArgRemaining a

data Params

Constructors

Params

Fields

paramsFlags :: [(Nid, Maybe String)]

paramsPinnedArgs :: [String]

paramsRemainingArgs :: [String]

getParams :: Param p => Params -> forall a. p a -> Ret p a