Data.Registry.Options.OptionDescription

Description for options A option has a long name (unless it's an argument), a short name, a metavar (its type), a help text

Documentation

data OptionDescription

Optional values used to document a command line option

• name is a "long" name, like launch-missiles
• short is just a character, like l
• metavar describes the type of value which is expected, like BOOL
• help is a piece of text describing the usage of the option, like "destroy everything"

Constructors

OptionDescription

Fields

• _name :: Maybe Text
• _aliases :: [Text]
• _shortName :: Maybe Char
• _metavar :: Maybe Text
• _help :: Maybe Text

Instances

Monoid OptionDescription

Defined in Data.Registry.Options.OptionDescription

Methods

mempty :: OptionDescription

mappend :: OptionDescription -> OptionDescription -> OptionDescription

mconcat :: [OptionDescription] -> OptionDescription

Semigroup OptionDescription

The Semigroup instance is used to collect several descriptions and aggregate them together, for example name "force" <> short 'f'

The second option always takes precedence on the first one for example metavar "m1" <> metavar "m2" == metavar "m2"

Defined in Data.Registry.Options.OptionDescription

Methods

(<>) :: OptionDescription -> OptionDescription -> OptionDescription

sconcat :: NonEmpty OptionDescription -> OptionDescription

stimes :: Integral b => b -> OptionDescription -> OptionDescription

Show OptionDescription

Defined in Data.Registry.Options.OptionDescription

Methods

showsPrec :: Int -> OptionDescription -> ShowS

show :: OptionDescription -> String

showList :: [OptionDescription] -> ShowS

Eq OptionDescription

Defined in Data.Registry.Options.OptionDescription

Methods

(==) :: OptionDescription -> OptionDescription -> Bool

(/=) :: OptionDescription -> OptionDescription -> Bool

Lift OptionDescription

Defined in Data.Registry.Options.TH

Methods

lift :: Quote m => OptionDescription -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => OptionDescription -> Code m OptionDescription

type OptionDescriptionUpdate = OptionDescription -> OptionDescription

Function updating an OptionDescription

type OptionDescriptionUpdates = [OptionDescriptionUpdate]

List of description updates

makeOptionDescription :: OptionDescriptionUpdates -> OptionDescription

Apply a list of option description updates, from left to right, to the empty description

name :: Text -> OptionDescriptionUpdate

Create an OptionDescriptionUpdate with a long hyphenated name, for example name "collect-all"

alias :: Text -> OptionDescriptionUpdate

Create an OptionDescriptionUpdate with an alias for a given name

short :: Char -> OptionDescriptionUpdate

Create an OptionDescriptionUpdate with a short name, for example short 'q'

noShort :: OptionDescriptionUpdate

Create an OptionDescriptionUpdate with specifying that there must be no short name

metavar :: Text -> OptionDescriptionUpdate

Create an OptionDescriptionUpdate with a metavar to indicate the type of an option, for example metavar FILE

help :: Text -> OptionDescriptionUpdate

Create an OptionDescriptionUpdate with some help text, for example help "force the copy"

displayCliOptionName :: OptionDescription -> Text

Display a OptionDescription name as a hyphenated name return empty if no name has been defined yet

getNames :: OptionDescription -> [Text]

Return the possible names for an OptionDescription if they are defined