Blammo.Logging.Colors

Generic facilities for adding terminal escapes to Text

Recommended usage:

Colors {..} <- getColorsLogger -- for example
pure $ "This text will be " <> red "red" <> "."

Documentation

data Colors

Constructors

Colors

Fields

• gray :: Text -> Text
• black :: Text -> Text
• cyan :: Text -> Text
• magenta :: Text -> Text
• blue :: Text -> Text
• yellow :: Text -> Text
• green :: Text -> Text
• red :: Text -> Text
• bold :: Text -> Text
• dim :: Text -> Text

noColors :: Colors

getColors :: Bool -> Colors

getColorsLogger :: (MonadReader env m, HasLogger env) => m Colors

Return Colors consistent with whatever your logging is doing

getColorsHandle :: (MonadIO m, MonadReader env m, HasLogger env) => Handle -> m Colors

Return Colors consistent with logging, but for Handle

This is useful if you are building text to print to a handle that is not the one you are logging to.

For example, say you are using,

LOG_COLOR=auto
LOG_DESTINATION=@some-file.log

That will not log with color, so getColorsLogger will be noColor. If you're building other text to be printed out, you probably want to respect that LOG_COLOR=auto, so you would use this function instead.

getColorsStdout :: (MonadIO m, MonadReader env m, HasLogger env) => m Colors

Short-cut for getColorsHandle stdout

getColorsStderr :: (MonadIO m, MonadReader env m, HasLogger env) => m Colors

Short-cut for getColorsHandle stderr