Cli.Extras.Types

Documentation

data Output

Constructors

Output_Log (WithSeverity Text)

Output_LogRaw (WithSeverity Text)

Output_Write [TerminalString]

Output_Overwrite [TerminalString]

Output_ClearLine

Instances

Eq Output

Defined in Cli.Extras.Types

Methods

(==) :: Output -> Output -> Bool

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

Ord Output

Defined in Cli.Extras.Types

Methods

compare :: Output -> Output -> Ordering

(<) :: Output -> Output -> Bool

(<=) :: Output -> Output -> Bool

(>) :: Output -> Output -> Bool

(>=) :: Output -> Output -> Bool

max :: Output -> Output -> Output

min :: Output -> Output -> Output

Show Output

Defined in Cli.Extras.Types

Methods

showsPrec :: Int -> Output -> ShowS

show :: Output -> String

showList :: [Output] -> ShowS

Monad m => MonadLog Output (CliT e m)

Defined in Cli.Extras.Types

Methods

logMessageFree :: (forall n. Monoid n => (Output -> n) -> n) -> CliT e m ()

Monad m => MonadLog Output (DieT e m)

Defined in Cli.Extras.Types

Methods

logMessageFree :: (forall n. Monoid n => (Output -> n) -> n) -> DieT e m ()

type CliLog m = MonadLog Output m

type CliThrow e m = MonadError e m

putLog :: CliLog m => Severity -> Text -> m ()

Log a message to the console.

The message is guaranteed to be logged uninterrupted, even if there are ongoing spinners.

newtype DieT e m a

Constructors

DieT

Fields

• unDieT :: ReaderT (e -> (Text, ExitCode)) (LoggingT Output m) a

Instances

MonadReader r m => MonadReader r (DieT e m)

Defined in Cli.Extras.Types

Methods

ask :: DieT e m r

local :: (r -> r) -> DieT e m a -> DieT e m a

reader :: (r -> a) -> DieT e m a

MonadIO m => MonadError e (DieT e m)

Defined in Cli.Extras.Types

Methods

throwError :: e -> DieT e m a

catchError :: DieT e m a -> (e -> DieT e m a) -> DieT e m a

Monad m => MonadLog Output (DieT e m)

Defined in Cli.Extras.Types

Methods

logMessageFree :: (forall n. Monoid n => (Output -> n) -> n) -> DieT e m ()

MonadTrans (DieT e)

Defined in Cli.Extras.Types

Methods

lift :: Monad m => m a -> DieT e m a

Monad m => Monad (DieT e m)

Defined in Cli.Extras.Types

Methods

(>>=) :: DieT e m a -> (a -> DieT e m b) -> DieT e m b

(>>) :: DieT e m a -> DieT e m b -> DieT e m b

return :: a -> DieT e m a

Functor m => Functor (DieT e m)

Defined in Cli.Extras.Types

Methods

fmap :: (a -> b) -> DieT e m a -> DieT e m b

(<$) :: a -> DieT e m b -> DieT e m a

MonadFail m => MonadFail (DieT e m)

Defined in Cli.Extras.Types

Methods

fail :: String -> DieT e m a

Applicative m => Applicative (DieT e m)

Defined in Cli.Extras.Types

Methods

pure :: a -> DieT e m a

(<*>) :: DieT e m (a -> b) -> DieT e m a -> DieT e m b

liftA2 :: (a -> b -> c) -> DieT e m a -> DieT e m b -> DieT e m c

(*>) :: DieT e m a -> DieT e m b -> DieT e m b

(<*) :: DieT e m a -> DieT e m b -> DieT e m a

MonadIO m => MonadIO (DieT e m)

Defined in Cli.Extras.Types

Methods

liftIO :: IO a -> DieT e m a

MonadThrow m => MonadThrow (DieT e m)

Defined in Cli.Extras.Types

Methods

throwM :: Exception e0 => e0 -> DieT e m a

MonadCatch m => MonadCatch (DieT e m)

Defined in Cli.Extras.Types

Methods

catch :: Exception e0 => DieT e m a -> (e0 -> DieT e m a) -> DieT e m a

MonadMask m => MonadMask (DieT e m)

Defined in Cli.Extras.Types

Methods

mask :: ((forall a. DieT e m a -> DieT e m a) -> DieT e m b) -> DieT e m b

uninterruptibleMask :: ((forall a. DieT e m a -> DieT e m a) -> DieT e m b) -> DieT e m b

generalBracket :: DieT e m a -> (a -> ExitCase b -> DieT e m c) -> (a -> DieT e m b) -> DieT e m (b, c)

data CliConfig e

Constructors

CliConfig

Fields

• _cliConfig_logLevel :: IORef Severity

  We are capable of changing the log level at runtime

• _cliConfig_noColor :: Bool

  Disallow coloured output

• _cliConfig_noSpinner :: Bool

  Disallow spinners

• _cliConfig_lock :: MVar Bool

  Whether the last message was an Overwrite output

• _cliConfig_tipDisplayed :: IORef Bool

  Whether the user tip (to make verbose) was already displayed

• _cliConfig_spinnerStack :: IORef ([Bool], [TerminalString])

  Stack of logs from nested spinners

• _cliConfig_errorLogExitCode :: e -> (Text, ExitCode)

  Handler for failures. Determines, given an error, what message should be printed, and what the exit status should be.

• _cliConfig_theme :: CliTheme

  Theme strings for spinners

Instances

Monad m => MonadReader (CliConfig e) (CliT e m)

Defined in Cli.Extras.Types

Methods

ask :: CliT e m (CliConfig e)

local :: (CliConfig e -> CliConfig e) -> CliT e m a -> CliT e m a

reader :: (CliConfig e -> a) -> CliT e m a

class Monad m => HasCliConfig e m | m -> e where

Methods

getCliConfig :: m (CliConfig e)

Instances

Monad m => HasCliConfig e (CliT e m)

Defined in Cli.Extras.Types

Methods

getCliConfig :: CliT e m (CliConfig e)

HasCliConfig e m => HasCliConfig e (ExceptT e m)

Defined in Cli.Extras.Types

Methods

getCliConfig :: ExceptT e m (CliConfig e)

HasCliConfig e m => HasCliConfig e (StateT s m)

Defined in Cli.Extras.Types

Methods

getCliConfig :: StateT s m (CliConfig e)

(Monoid w, HasCliConfig e m) => HasCliConfig e (WriterT w m)

Defined in Cli.Extras.Types

Methods

getCliConfig :: WriterT w m (CliConfig e)

HasCliConfig e m => HasCliConfig e (ReaderT r m)

Defined in Cli.Extras.Types

Methods

getCliConfig :: ReaderT r m (CliConfig e)

newtype CliT e m a

Constructors

CliT

Fields

• unCliT :: ReaderT (CliConfig e) (DieT e m) a

Instances

MonadIO m => MonadError e (CliT e m)

Defined in Cli.Extras.Types

Methods

throwError :: e -> CliT e m a

catchError :: CliT e m a -> (e -> CliT e m a) -> CliT e m a

Monad m => MonadLog Output (CliT e m)

Defined in Cli.Extras.Types

Methods

logMessageFree :: (forall n. Monoid n => (Output -> n) -> n) -> CliT e m ()

Monad m => HasCliConfig e (CliT e m)

Defined in Cli.Extras.Types

Methods

getCliConfig :: CliT e m (CliConfig e)

MonadTrans (CliT e)

Defined in Cli.Extras.Types

Methods

lift :: Monad m => m a -> CliT e m a

Monad m => MonadReader (CliConfig e) (CliT e m)

Defined in Cli.Extras.Types

Methods

ask :: CliT e m (CliConfig e)

local :: (CliConfig e -> CliConfig e) -> CliT e m a -> CliT e m a

reader :: (CliConfig e -> a) -> CliT e m a

Monad m => Monad (CliT e m)

Defined in Cli.Extras.Types

Methods

(>>=) :: CliT e m a -> (a -> CliT e m b) -> CliT e m b

(>>) :: CliT e m a -> CliT e m b -> CliT e m b

return :: a -> CliT e m a

Functor m => Functor (CliT e m)

Defined in Cli.Extras.Types

Methods

fmap :: (a -> b) -> CliT e m a -> CliT e m b

(<$) :: a -> CliT e m b -> CliT e m a

MonadFail m => MonadFail (CliT e m)

Defined in Cli.Extras.Types

Methods

fail :: String -> CliT e m a

Applicative m => Applicative (CliT e m)

Defined in Cli.Extras.Types

Methods

pure :: a -> CliT e m a

(<*>) :: CliT e m (a -> b) -> CliT e m a -> CliT e m b

liftA2 :: (a -> b -> c) -> CliT e m a -> CliT e m b -> CliT e m c

(*>) :: CliT e m a -> CliT e m b -> CliT e m b

(<*) :: CliT e m a -> CliT e m b -> CliT e m a

MonadIO m => MonadIO (CliT e m)

Defined in Cli.Extras.Types

Methods

liftIO :: IO a -> CliT e m a

MonadThrow m => MonadThrow (CliT e m)

Defined in Cli.Extras.Types

Methods

throwM :: Exception e0 => e0 -> CliT e m a

MonadCatch m => MonadCatch (CliT e m)

Defined in Cli.Extras.Types

Methods

catch :: Exception e0 => CliT e m a -> (e0 -> CliT e m a) -> CliT e m a

MonadMask m => MonadMask (CliT e m)

Defined in Cli.Extras.Types

Methods

mask :: ((forall a. CliT e m a -> CliT e m a) -> CliT e m b) -> CliT e m b

uninterruptibleMask :: ((forall a. CliT e m a -> CliT e m a) -> CliT e m b) -> CliT e m b

generalBracket :: CliT e m a -> (a -> ExitCase b -> CliT e m c) -> (a -> CliT e m b) -> CliT e m (b, c)