Util.CLI

Utilities for command line options parsing (we use optparse-applicative).

Some names exported from this module are quite general when if you do not assume optparse-applicative usage, so consider using explicit imports for it.

General helpers

maybeAddDefault :: HasValue f => (a -> String) -> Maybe a -> Mod f a

Maybe add the default value and make sure it will be shown in help message.

outputOption :: Parser (Maybe FilePath)

Parser for path to a file where output will be writen.

Named and type class based parsing

class HasCLReader a where

Supporting typeclass for namedParser. It specifies how a value should be parsed from command line. Even though the main purpose of this class is to implement helpers below, feel free to use it for other goals.

Methods

getReader :: ReadM a

getMetavar :: String

This string will be passed to the metavar function, hence we use String type rather Text (even though we use Text almost everywhere).

Instances

HasCLReader Int

Defined in Util.CLI

Methods

getReader :: ReadM Int

getMetavar :: String

HasCLReader Int8

Defined in Util.CLI

Methods

getReader :: ReadM Int8

getMetavar :: String

HasCLReader Int16

Defined in Util.CLI

Methods

getReader :: ReadM Int16

getMetavar :: String

HasCLReader Int32

Defined in Util.CLI

Methods

getReader :: ReadM Int32

getMetavar :: String

HasCLReader Int64

Defined in Util.CLI

Methods

getReader :: ReadM Int64

getMetavar :: String

HasCLReader Integer

Defined in Util.CLI

Methods

getReader :: ReadM Integer

getMetavar :: String

HasCLReader Natural

Defined in Util.CLI

Methods

getReader :: ReadM Natural

getMetavar :: String

HasCLReader Word

Defined in Util.CLI

Methods

getReader :: ReadM Word

getMetavar :: String

HasCLReader Word8

Defined in Util.CLI

Methods

getReader :: ReadM Word8

getMetavar :: String

HasCLReader Word16

Defined in Util.CLI

Methods

getReader :: ReadM Word16

getMetavar :: String

HasCLReader Word32

Defined in Util.CLI

Methods

getReader :: ReadM Word32

getMetavar :: String

HasCLReader Word64

Defined in Util.CLI

Methods

getReader :: ReadM Word64

getMetavar :: String

HasCLReader String

Defined in Util.CLI

Methods

getReader :: ReadM String

getMetavar :: String

HasCLReader Text

Defined in Util.CLI

Methods

getReader :: ReadM Text

getMetavar :: String

HasCLReader EpName

Defined in Michelson.Untyped.Entrypoints

Methods

getReader :: ReadM EpName

getMetavar :: String

HasCLReader MText

Defined in Michelson.Text

Methods

getReader :: ReadM MText

getMetavar :: String

HasCLReader KeyHash

Defined in Tezos.Crypto

Methods

getReader :: ReadM KeyHash

getMetavar :: String

HasCLReader SecretKey

Defined in Tezos.Crypto

Methods

getReader :: ReadM SecretKey

getMetavar :: String

HasCLReader Mutez

Defined in Tezos.Core

Methods

getReader :: ReadM Mutez

getMetavar :: String

HasCLReader Address

Defined in Tezos.Address

Methods

getReader :: ReadM Address

getMetavar :: String

HasCLReader Value

Defined in Morley.CLI

Methods

getReader :: ReadM Value

getMetavar :: String

mkCLOptionParser :: forall a. (Buildable a, HasCLReader a) => Maybe a -> ("name" :! String) -> ("help" :! String) -> Parser a

Create a Parser for a value using HasCLReader instance (hence CL in the name). It uses reader and metavar from that class, the rest should be supplied as arguments.

We expect some common modifiers to be always provided, a list of extra modifies can be provided as well.

mkCLOptionParserExt :: forall a. (Buildable a, HasCLReader a) => Maybe a -> ("name" :! String) -> ("help" :! String) -> [Mod OptionFields a] -> Parser a

A more general version of mkCLOptionParser which takes a list of extra (not as widely used) modifiers.

mkCLArgumentParser :: forall a. (Buildable a, HasCLReader a) => Maybe a -> ("help" :! String) -> Parser a

Akin to mkCLOptionParser, but for arguments rather than options.

mkCLArgumentParserExt :: forall a. (Buildable a, HasCLReader a) => Maybe a -> ("help" :! String) -> [Mod ArgumentFields a] -> Parser a

Akin to mkCLOptionParserExt, but for arguments rather than options.

mkCommandParser :: String -> Parser a -> String -> Mod CommandFields a

Parser for command options

namedParser :: forall (a :: Type) (name :: Symbol). (Buildable a, HasCLReader a, KnownSymbol name) => Maybe a -> String -> Parser (name :! a)

Create a Parser for a value using its type-level name.

This expects type-level name to be in camelCase as appropriate for Haskell and transforms the variable inside.

Helpers for defining HasCLReader

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

Convert a function producing an Either into a reader.

As an example, one can create a ReadM from an attoparsec Parser easily with

import qualified Data.Attoparsec.Text as A
import qualified Data.Text as T
attoparsecReader :: A.Parser a -> ReadM a
attoparsecReader p = eitherReader (A.parseOnly p . T.pack)

readerError :: String -> ReadM a

Abort option reader by exiting with an error message.

integralReader :: Integral a => ReadM a

Parse a number, checking for overflows and other stuff.