Options.Applicative.Help
- Package
- purescript-optparse
- Repository
- f-o-a-m/purescript-optparse
Re-exports from Options.Applicative.Help.Chunk
#stringChunk Source
stringChunk :: String -> Chunk Doc
Convert a 'String' into a 'Chunk'. This satisfies:
#listToChunk Source
listToChunk :: forall a. Monoid a => Array a -> Chunk a
Concatenate a list into a Chunk. 'listToChunk' satisfies:
#extractChunk Source
extractChunk :: forall a. Monoid a => Chunk a -> a
Part of a constrained comonad instance.
#(<</>>) Source
Operator alias for Options.Applicative.Help.Chunk.chunkBesideOrBelow (right-associative / precedence 6)
#(<<+>>) Source
Operator alias for Options.Applicative.Help.Chunk.chunkBeside (right-associative / precedence 6)
Re-exports from Options.Applicative.Help.Core
#suggestionsHelp Source
suggestionsHelp :: Chunk Doc -> ParserHelp
#parserUsage Source
parserUsage :: forall a. ParserPrefs -> Parser a -> String -> Doc
Generate option summary.
#parserHelp Source
parserHelp :: forall a. ParserPrefs -> Parser a -> ParserHelp
Generate the help text for a program.
#missingDesc Source
missingDesc :: forall a. ParserPrefs -> Parser a -> Chunk Doc
Generate a brief help text for a parser, only including mandatory
#headerHelp Source
headerHelp :: Chunk Doc -> ParserHelp
#fullDesc Source
fullDesc :: forall a. ParserPrefs -> Parser a -> Chunk Doc
Generate a full help text for a parser.
#briefDesc Source
briefDesc :: forall a. ParserPrefs -> Parser a -> Chunk Doc
Generate a brief help text for a parser.
Re-exports from Options.Applicative.Help.Levenshtein
Re-exports from Options.Applicative.Help.Pretty
#semiBraces Source
semiBraces :: Array Doc -> Doc
The document @(semiBraces xs)@ separates the documents @xs@ with
#renderSmart Source
renderSmart :: Number -> Int -> Doc -> SimpleDoc
A slightly smarter rendering algorithm with more lookahead. It provides abcdef, abcdef,
#renderPretty Source
renderPretty :: Number -> Int -> Doc -> SimpleDoc
This is the default pretty printer which is used by 'show',
#renderCompact Source
renderCompact :: Doc -> SimpleDoc
@(renderCompact x)@ renders document @x@ without adding any
#indentation Source
indentation :: Int -> String
#appendWithSpace Source
appendWithSpace :: Doc -> Doc -> Doc
The document @(x <+> y)@ concatenates document @x@ and @y@ with a
#appendWithSoftline Source
appendWithSoftline :: Doc -> Doc -> Doc
The document @(x </> y)@ concatenates document @x@ and @y@ with a
#appendWithSoftbreak Source
appendWithSoftbreak :: Doc -> Doc -> Doc
The document @(x <//> y)@ concatenates document @x@ and @y@ with
#appendWithLinebreak Source
appendWithLinebreak :: Doc -> Doc -> Doc
The document @(x <$$> y)@ concatenates document @x@ and @y@ with
#appendWithLine Source
appendWithLine :: Doc -> Doc -> Doc
The document @(x <$> y)@ concatenates document @x@ and @y@ with a
#(</>) Source
Operator alias for Text.PrettyPrint.Leijen.appendWithSoftline (right-associative / precedence 5)
#(<//>) Source
Operator alias for Text.PrettyPrint.Leijen.appendWithSoftbreak (right-associative / precedence 5)
#(<+>) Source
Operator alias for Text.PrettyPrint.Leijen.appendWithSpace (right-associative / precedence 6)
#(<$$>) Source
Operator alias for Text.PrettyPrint.Leijen.appendWithLinebreak (right-associative / precedence 5)
#(.$.) Source
Operator alias for Text.PrettyPrint.Leijen.appendWithLine (right-associative / precedence 5)
Re-exports from Options.Applicative.Help.Types
#ParserHelp Source
#renderHelp Source
renderHelp :: Int -> ParserHelp -> String
Convert a help text to 'String'.
- 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