Safe Haskell	Safe-Inferred
Language	GHC2021

Options.Applicative.Builder.Extra

Description

Extra functions for optparse-applicative.

Synopsis

boolFlags :: Bool -> String -> String -> Mod FlagFields Bool -> Parser Bool
boolFlagsNoDefault :: String -> String -> Mod FlagFields Bool -> Parser Bool
firstBoolFlagsNoDefault :: String -> String -> Mod FlagFields (Maybe Bool) -> Parser (First Bool)
firstBoolFlagsTrue :: String -> String -> Mod FlagFields FirstTrue -> Parser FirstTrue
firstBoolFlagsFalse :: String -> String -> Mod FlagFields FirstFalse -> Parser FirstFalse
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)
optionalFirstTrue :: Alternative f => f Bool -> f FirstTrue
optionalFirstFalse :: Alternative f => f Bool -> f FirstFalse
absFileOption :: Mod OptionFields (Path Abs File) -> Parser (Path Abs File)
relFileOption :: Mod OptionFields (Path Rel File) -> Parser (Path Rel File)
absDirOption :: Mod OptionFields (Path Abs Dir) -> Parser (Path Abs Dir)
relDirOption :: Mod OptionFields (Path Rel Dir) -> Parser (Path Rel Dir)
eitherReader' :: Show e => (String -> Either e a) -> ReadM a
fileCompleter :: Completer
fileExtCompleter :: [String] -> Completer
dirCompleter :: Completer
data PathCompleterOpts = PathCompleterOpts {
- pcoAbsolute :: Bool
- pcoRelative :: Bool
- pcoRootDir :: Maybe FilePath
- pcoFileFilter :: FilePath -> Bool
- pcoDirFilter :: FilePath -> Bool
}
defaultPathCompleterOpts :: PathCompleterOpts
pathCompleterWith :: PathCompleterOpts -> Completer
unescapeBashArg :: String -> String
showHelpText :: ParseError

Documentation

boolFlags Source #

Arguments

:: Bool	Default value
-> String	Flag name
-> String	Help suffix
-> Mod FlagFields Bool
-> Parser Bool

Enable/disable flags for a Bool.

boolFlagsNoDefault Source #

Arguments

:: String	Flag name
-> String	Help suffix
-> Mod FlagFields Bool
-> Parser Bool

Enable/disable flags for a Bool, without a default case (to allow chaining with <|>).

firstBoolFlagsNoDefault :: String -> String -> Mod FlagFields (Maybe Bool) -> Parser (First Bool) Source #

Flag with no default of True or False

firstBoolFlagsTrue :: String -> String -> Mod FlagFields FirstTrue -> Parser FirstTrue Source #

Flag with a Semigroup instance and a default of True

firstBoolFlagsFalse :: String -> String -> Mod FlagFields FirstFalse -> Parser FirstFalse Source #

Flag with a Semigroup instance and a default of False

enableDisableFlags Source #

Arguments

:: 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 #

Arguments

:: 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 <|>)

extraHelpOption Source #

Arguments

:: Bool	Hide from the brief description?
-> String	Program name, e.g. `"stack"`
-> String	Option glob expression, e.g. `"docker*"`
-> String	Help option name, e.g. `"docker-help"`
-> 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.

execExtraHelp Source #

Arguments

:: [String]	Command line arguments
-> String	Extra help option name, e.g. `"docker-help"`
-> 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 #

option, specialized to Text.

textArgument :: Mod ArgumentFields Text -> Parser Text Source #

argument, specialized to Text.

optionalFirst :: Alternative f => f a -> f (First a) Source #

Like optional, but returning a First.

optionalFirstTrue :: Alternative f => f Bool -> f FirstTrue Source #

Like optional, but returning a FirstTrue.

optionalFirstFalse :: Alternative f => f Bool -> f FirstFalse Source #

Like optional, but returning a FirstFalse.

absFileOption :: Mod OptionFields (Path Abs File) -> Parser (Path Abs File) Source #

relFileOption :: Mod OptionFields (Path Rel File) -> Parser (Path Rel File) Source #

absDirOption :: Mod OptionFields (Path Abs Dir) -> Parser (Path Abs Dir) Source #

relDirOption :: Mod OptionFields (Path Rel Dir) -> Parser (Path Rel Dir) Source #

eitherReader' :: Show e => (String -> Either e a) -> ReadM a Source #

Like eitherReader, but accepting any Show e on the Left.

fileCompleter :: Completer Source #

fileExtCompleter :: [String] -> Completer Source #

dirCompleter :: Completer Source #

data PathCompleterOpts Source #

Constructors

PathCompleterOpts
Fields pcoAbsolute :: Bool pcoRelative :: Bool pcoRootDir :: Maybe FilePath pcoFileFilter :: FilePath -> Bool pcoDirFilter :: FilePath -> Bool

defaultPathCompleterOpts :: PathCompleterOpts Source #

pathCompleterWith :: PathCompleterOpts -> Completer Source #

unescapeBashArg :: String -> String Source #

showHelpText :: ParseError Source #