Helper

Parse and pretty print the string of help of commands

Documentation

data CommandHelp

structure for the help of a command

Constructors

CommandHelp

Fields

name :: String

the command name

synopsis :: String

how to run it

descriptions :: [String]

aspects

errors :: [String]

errors explanations

implementation :: String

implementation state

Instances

Show CommandHelp

parseACommandHelp :: CharParser () CommandHelp

parses a CommandHelp

parseCommandsHelp :: CharParser () [CommandHelp]

parses all commands help

run

Arguments

:: String

The string to parse

-> GenParser Char () a

the parser to use

-> (a -> Maybe b)

a function to use on the result , if it succed

-> Either String (Maybe b)

the error showed if it fails or the result closed

run the parser against a string

tabulate :: [[String]] -> String

create a nice table from lines of words

listOfCommands

Arguments

:: String

the string with the help inside

-> Either String (Maybe String)

a parse error or Just a prettyprint of a list of command helps

parse a prettyprint of a list of command helps from a string

helpCommand

Arguments

:: String

the command name

-> String

the string with the help inside

-> Either String (Maybe String)

a parse error or (Just the command help or Nothing if the command is missing)

parse a prettyprint of a list of command helps from a string