Safe Haskell | Safe |
---|---|
Language | Haskell2010 |
Extra functions for optparse-applicative.
- boolFlags :: Bool -> String -> String -> Mod FlagFields Bool -> Parser Bool
- boolFlagsNoDefault :: String -> String -> Mod FlagFields Bool -> Parser Bool
- maybeBoolFlags :: String -> String -> Mod FlagFields (Maybe Bool) -> Parser (Maybe Bool)
- firstBoolFlags :: String -> String -> Mod FlagFields (Maybe Bool) -> Parser (First Bool)
- enableDisableFlags :: a -> a -> a -> String -> String -> Mod FlagFields a -> Parser a
- enableDisableFlagsNoDefault :: a -> a -> String -> String -> Mod FlagFields a -> Parser a
- extraHelpOption :: Bool -> String -> String -> String -> Parser (a -> a)
- execExtraHelp :: [String] -> String -> Parser a -> String -> IO ()
- textOption :: Mod OptionFields Text -> Parser Text
- textArgument :: Mod ArgumentFields Text -> Parser Text
- optionalFirst :: Alternative f => f a -> f (First a)
Documentation
Enable/disable flags for a Bool
.
firstBoolFlags :: String -> String -> Mod FlagFields (Maybe Bool) -> Parser (First Bool) Source
Like maybeBoolFlags
, but parsing a First
.
:: a | Default value |
-> a | Enabled value |
-> a | Disabled value |
-> String | Name |
-> String | Help suffix |
-> Mod FlagFields a | |
-> Parser a |
Enable/disable flags for any type.
enableDisableFlagsNoDefault Source
:: a | Enabled value |
-> a | Disabled value |
-> String | Name |
-> String | Help suffix |
-> Mod FlagFields a | |
-> Parser a |
Enable/disable flags for any type, without a default (to allow chaining with <|>
)
:: Bool | Hide from the brief description? |
-> String | Program name, e.g. |
-> String | Option glob expression, e.g. |
-> String | Help option name, e.g. |
-> Parser (a -> a) |
Show an extra help option (e.g. --docker-help
shows help for all --docker*
args).
To actually have that help appear, use execExtraHelp
before executing the main parser.
:: [String] | Command line arguments |
-> String | Extra help option name, e.g. |
-> Parser a | Option parser for the relevant command |
-> String | Option description |
-> IO () |
Display extra help if extra help option passed in arguments.
Since optparse-applicative doesn't allow an arbitrary IO action for an abortOption
, this
was the best way I found that doesn't require manually formatting the help.
textOption :: Mod OptionFields Text -> Parser Text Source
optionalFirst :: Alternative f => f a -> f (First a) Source