Climb

Building blocks for a GHCI-like REPL with colon-commands.

Documentation

type Command m = Text -> m ReplDirective

A Command takes some input, performs some effect, and returns a directive (continue or quit).

data CommandErr

Sometimes things go wrong...

Constructors

CommandErrExpectedNoInput

An option Command got input when it expected None

CommandErrUnknownCommand !Text

An option Command was not found by name.

Instances

Exception CommandErr

Defined in Climb

Methods

toException :: CommandErr -> SomeException

fromException :: SomeException -> Maybe CommandErr

displayException :: CommandErr -> String

Show CommandErr

Defined in Climb

Methods

showsPrec :: Int -> CommandErr -> ShowS

show :: CommandErr -> String

showList :: [CommandErr] -> ShowS

Eq CommandErr

Defined in Climb

Methods

(==) :: CommandErr -> CommandErr -> Bool

(/=) :: CommandErr -> CommandErr -> Bool

type Completion m = Text -> m [Text]

A Completion takes some input and returns potential matches.

type OptionCommands m = Map Text (Text, Command m)

List of Commands by name with help text.

data ReplDef m

Defines a REPL with commands, options, and completion.

Constructors

ReplDef

Fields

• rdOnInterrupt :: !ReplDirective
• rdGreeting :: !Text
• rdPrompt :: !Text
• rdOptionCommands :: !(OptionCommands m)
• rdExecCommand :: !(Command m)
• rdCompletion :: !(Completion m)

data ReplDirective

Directive to control voluntary REPL termination.

Constructors

ReplQuit

ReplContinue

Instances

Show ReplDirective

Defined in Linenoise.Repl

Methods

showsPrec :: Int -> ReplDirective -> ShowS

show :: ReplDirective -> String

showList :: [ReplDirective] -> ShowS

Eq ReplDirective

Defined in Linenoise.Repl

Methods

(==) :: ReplDirective -> ReplDirective -> Bool

(/=) :: ReplDirective -> ReplDirective -> Bool

bareCommand :: MonadThrow m => m ReplDirective -> Command m

Helps you define commands that expect no input.

noOptionCommands :: OptionCommands m

noCompletion :: Applicative m => Completion m

runReplDef :: (MonadCatch m, MonadUnliftIO m) => ReplDef m -> m ()

Runs a REPL as defined.

stepReplDef :: MonadThrow m => ReplDef m -> Text -> m ReplDirective

Processes a single line of input. Useful for testing. (Note that this does not handle default option commands.)