Module

Options.Applicative.Builder

Package: purescript-optparse
Repository: f-o-a-m/purescript-optparse

#subparser Source

subparser :: forall a. Mod CommandFields a -> Parser a

Builder for a command parser. The 'command' modifier can be used to

#strArgument Source

strArgument :: Mod ArgumentFields String -> Parser String

Builder for a 'String' argument.

#argument Source

argument :: forall a. ReadM a -> Mod ArgumentFields a -> Parser a

Builder for an argument parser.

#flag' Source

flag' :: forall a. a -> Mod FlagFields a -> Parser a

Builder for a flag parser without a default value.

#abortOption Source

abortOption :: forall a. ParseError -> Mod OptionFields (a -> a) -> Parser (a -> a)

An option that always fails.

#infoOption Source

infoOption :: forall a. String -> Mod OptionFields (a -> a) -> Parser (a -> a)

An option that always fails and displays a message.

#strOption Source

strOption :: Mod OptionFields String -> Parser String

Builder for an option taking a 'String' argument.

#option Source

option :: forall a. ReadM a -> Mod OptionFields a -> Parser a

Builder for an option using the given reader.

#helpDoc Source

helpDoc :: forall a f. Maybe Doc -> Mod f a

Specify the help text for an option as a 'Text.PrettyPrint.ANSI.Leijen.Doc'

#showDefaultWith Source

showDefaultWith :: forall a f. (a -> String) -> Mod f a

Specify a function to show the default value for an option.

#showDefault Source

showDefault :: forall a f. Show a => Mod f a

Show the default value for this option using its 'Show' instance.

#metavar Source

metavar :: forall a f. HasMetavar f => String -> Mod f a

Specify a metavariable for the argument.

#noArgError Source

noArgError :: forall a. ParseError -> Mod OptionFields a

Specify the error to display when no argument is provided to this option.

#hidden Source

hidden :: forall a f. Mod f a

Hide this option from the brief description.

#style Source

style :: forall a f. (Doc -> Doc) -> Mod f a

Apply a function to the option description in the usage text.

#command Source

command :: forall a. String -> ParserInfo a -> Mod CommandFields a

Add a command to a subparser option.

#commandGroup Source

commandGroup :: forall a. String -> Mod CommandFields a

Add a description to a group of commands.

#completeWith Source

completeWith :: forall a f. HasCompleter f => Array String -> Mod f a

Add a list of possible completion values.

#action Source

action :: forall a f. HasCompleter f => String -> Mod f a

Add a bash completion action. Common actions include @file@ and

#completer Source

completer :: forall a f. HasCompleter f => Completer -> Mod f a

Add a completer to an argument.

#boolean Source

boolean :: ReadM Boolean

Boolean 'Option' reader.

#maybeReader Source

maybeReader :: forall a. (String -> Maybe a) -> ReadM a

Convert a function producing a 'Maybe' into a reader.

#eitherReader Source

eitherReader :: forall a. (String -> Either String a) -> ReadM a

Convert a function producing an 'Either' into a reader.

#disabled Source

disabled :: forall a. ReadM a

Null 'Option' reader. All arguments will fail validation.

#InfoMod Source

newtype InfoMod a

Modifier for 'ParserInfo'.

Instances

#fullDesc Source

fullDesc :: forall a. InfoMod a

Show a full description in the help text of this parser.

#briefDesc Source

briefDesc :: forall a. InfoMod a

Only show a brief description in the help text of this parser.

#headerDoc Source

headerDoc :: forall a. Maybe Doc -> InfoMod a

Specify a header for this parser as a 'Text.PrettyPrint.ANSI.Leijen.Doc'

#footerDoc Source

footerDoc :: forall a. Maybe Doc -> InfoMod a

Specify a footer for this parser as a 'Text.PrettyPrint.ANSI.Leijen.Doc'

#progDesc Source

progDesc :: forall a. String -> InfoMod a

Specify a short program description.

#progDescDoc Source

progDescDoc :: forall a. Maybe Doc -> InfoMod a

Specify a short program description as a 'Text.PrettyPrint.ANSI.Leijen.Doc'

#failureCode Source

failureCode :: forall a. ExitCode -> InfoMod a

Specify an exit code if a parse error occurs.

#noIntersperse Source

noIntersperse :: forall a. InfoMod a

Disable parsing of regular options after arguments. After a positional

#forwardOptions Source

forwardOptions :: forall a. InfoMod a

Intersperse matched options and arguments normally, but allow unmatched

#info Source

info :: forall a. Parser a -> InfoMod a -> ParserInfo a

Create a 'ParserInfo' given a 'Parser' and a modifier.

#PrefsMod Source

newtype PrefsMod

Instances

#multiSuffix Source

multiSuffix :: String -> PrefsMod

Include a suffix to attach to the metavar when multiple values

#disambiguate Source

disambiguate :: PrefsMod

Turn on disambiguation.

#showHelpOnError Source

showHelpOnError :: PrefsMod

Show full help text on any error.

#showHelpOnEmpty Source

showHelpOnEmpty :: PrefsMod

Show the help text if the user enters only the program name or

#noBacktrack Source

noBacktrack :: PrefsMod

Turn off backtracking after subcommand is parsed.

#subparserInline Source

subparserInline :: PrefsMod

Allow full mixing of subcommand and parent arguments by inlining

#columns Source

columns :: Int -> PrefsMod

Set the maximum width of the generated help text.

#defaultPrefs Source

defaultPrefs :: ParserPrefs

Default preferences.

Re-exports from Options.Applicative.Builder.Internal

#OptionFields Source

newtype OptionFields a

Instances

#Mod Source

data Mod f a

An option modifier.

Option modifiers are values that represent a modification of the properties of an option.

The type parameter @a@ is the pure type of the option, while @f@ is a record containing its properties (e.g. 'OptionFields' for regular options, 'FlagFields' for flags, etc...).

An option modifier consists of 3 elements:

A field modifier, of the form @f a -> f a@. These are essentially (compositions of) setters for some of the properties supported by @f@.
An optional default value and function to display it.
A property modifier, of the form @OptProperties -> OptProperties@. This is just like the field modifier, but for properties applicable to any option.

Modifiers are instances of 'Monoid', and can be composed as such.

One rarely needs to deal with modifiers directly, as most of the times it is sufficient to pass them to builders (such as 'strOption' or 'flag') to create options (see 'Options.Applicative.Builder').

Contraints are often used to ensure that the modifiers can be sensibly applied. For example, positional arguments can't be specified by long or short names, so the 'HasName' constraint is used to ensure we have a flag or option.

Instances

Monoid (Mod f a)
Semigroup (Mod f a)
@since 0.13.0.0

#FlagFields Source

newtype FlagFields a

Instances

Newtype (FlagFields a) _
HasName FlagFields

#CommandFields Source

newtype CommandFields a

Instances

Newtype (CommandFields a) _
HasMetavar CommandFields

#ArgumentFields Source

newtype ArgumentFields a

Instances

#HasCompleter Source

class HasCompleter f

Instances

#HasMetavar Source

class HasMetavar f

Instances

#HasName Source

class HasName f

Instances

HasName OptionFields
HasName FlagFields

#HasValue Source

class HasValue f

Instances

#internal Source

internal :: forall a f. Mod f a

Hide this option from the help text

Re-exports from Options.Applicative.Types

#ReadM Source

newtype ReadM a

A reader is used by the 'option' and 'argument' builders to parse the data passed by the user on the command line into a data type.

The most common are 'str' which is used for 'String', there are readers for Int, Number, Boolean.

More complex types can use the 'eitherReader' or 'maybeReader' functions to pattern match or use a more expressive parser like a member of the 'Parsec' family. A newtype over 'ReaderT String Except', used by option readers.

Instances

#ParseError Source

data ParseError

Constructors

Instances

Monoid ParseError
Semigroup ParseError

#readerError Source

readerError :: forall a. String -> ReadM a

Abort option reader by exiting with an error message.

#readerAbort Source

readerAbort :: forall a. ParseError -> ReadM a

Abort option reader by exiting with a 'ParseError'.

Modules: Options.Applicative; Options.Applicative.BashCompletion; Options.Applicative.Builder; Options.Applicative.Builder.Completer; Options.Applicative.Builder.Internal; Options.Applicative.Common; Options.Applicative.Extra; Options.Applicative.Help; Options.Applicative.Help.Chunk; Options.Applicative.Help.Core; Options.Applicative.Help.Levenshtein; Options.Applicative.Help.Pretty; Options.Applicative.Help.Types; Options.Applicative.Internal; Options.Applicative.Internal.Utils; Options.Applicative.Types; Text.PrettyPrint.Leijen

Options.Applicative.Builder

#subparser Source

#strArgument Source

#argument Source

#flag Source

#flag' Source

#switch Source

#abortOption Source

#infoOption Source

#strOption Source

#option Source

#short Source

#long Source

#help Source

#helpDoc Source

#value Source

#showDefaultWith Source

#showDefault Source

#metavar Source

#noArgError Source

#hidden Source

#style Source

#command Source

#commandGroup Source

#completeWith Source

#action Source

#completer Source

#idm Source

#str Source

#int Source

#number Source

#boolean Source

#maybeReader Source

#eitherReader Source

#disabled Source

#InfoMod Source

Instances

#fullDesc Source

#briefDesc Source

#header Source

#headerDoc Source

#footer Source

#footerDoc Source

#progDesc Source

#progDescDoc Source

#failureCode Source

#noIntersperse Source

#forwardOptions Source

#info Source

#PrefsMod Source

Instances

#multiSuffix Source

#disambiguate Source

#showHelpOnError Source

#showHelpOnEmpty Source

#noBacktrack Source

#subparserInline Source

#columns Source

#prefs Source

#defaultPrefs Source

Re-exports from Options.Applicative.Builder.Internal

#OptionFields Source

Instances

#Mod Source

Instances

#FlagFields Source

Instances

#CommandFields Source

Instances

#ArgumentFields Source

Instances

#HasCompleter Source

Instances

#HasMetavar Source

Instances

#HasName Source

Instances

#HasValue Source

Instances

#internal Source