RIO.PrettyPrint

Type classes for optionally colored terminal output

class (HasLogFunc env, HasStylesUpdate env) => HasTerm env where

Methods

useColorL :: Lens' env Bool

termWidthL :: Lens' env Int

class HasStylesUpdate env where

Environment values with a styles update.

Since: 0.1.0.0

Methods

stylesUpdateL :: Lens' env StylesUpdate

Instances

HasStylesUpdate StylesUpdate

Defined in RIO.PrettyPrint.StylesUpdate

Methods

stylesUpdateL :: Lens' StylesUpdate StylesUpdate

Pretty printing functions

displayPlain :: (Pretty a, HasLogFunc env, HasStylesUpdate env, MonadReader env m, HasCallStack) => Int -> a -> m Utf8Builder

displayWithColor :: (HasTerm env, Pretty a, MonadReader env m, HasCallStack) => a -> m Utf8Builder

Logging based on pretty-print typeclass

prettyDebug :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => StyleDoc -> m ()

prettyInfo :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => StyleDoc -> m ()

prettyNote :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => StyleDoc -> m ()

prettyWarn :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => StyleDoc -> m ()

prettyError :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => StyleDoc -> m ()

prettyWarnNoIndent :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => StyleDoc -> m ()

prettyErrorNoIndent :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => StyleDoc -> m ()

prettyDebugL :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => [StyleDoc] -> m ()

prettyInfoL :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => [StyleDoc] -> m ()

prettyNoteL :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => [StyleDoc] -> m ()

prettyWarnL :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => [StyleDoc] -> m ()

prettyErrorL :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => [StyleDoc] -> m ()

prettyWarnNoIndentL :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => [StyleDoc] -> m ()

prettyErrorNoIndentL :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => [StyleDoc] -> m ()

prettyDebugS :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => String -> m ()

prettyInfoS :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => String -> m ()

prettyNoteS :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => String -> m ()

prettyWarnS :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => String -> m ()

prettyErrorS :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => String -> m ()

prettyWarnNoIndentS :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => String -> m ()

prettyErrorNoIndentS :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m) => String -> m ()

Semantic styling functions

These are used rather than applying colors or other styling directly, to provide consistency.

style :: Style -> StyleDoc -> StyleDoc

Annotate a StyleDoc with a Style.

displayMilliseconds :: Double -> StyleDoc

Formatting utils

bulletedList :: [StyleDoc] -> StyleDoc

Display a bulleted list of StyleDoc.

spacedBulletedList :: [StyleDoc] -> StyleDoc

Display a bulleted list of StyleDoc with a blank line between each.

debugBracket :: (HasCallStack, HasTerm env, MonadReader env m, MonadIO m, MonadUnliftIO m) => StyleDoc -> m a -> m a

Re-exports from Text.PrettyPrint.Leijen.Extended

class Pretty a where

Minimal complete definition

Nothing

Methods

pretty :: a -> StyleDoc

pretty :: Show a => a -> StyleDoc

Instances

Pretty ModuleName

Defined in Text.PrettyPrint.Leijen.Extended

Methods

pretty :: ModuleName -> StyleDoc

Pretty StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

pretty :: StyleDoc -> StyleDoc

Pretty (Path b Dir)

Defined in Text.PrettyPrint.Leijen.Extended

Methods

pretty :: Path b Dir -> StyleDoc

Pretty (Path b File)

Defined in Text.PrettyPrint.Leijen.Extended

Methods

pretty :: Path b File -> StyleDoc

data StyleDoc

A document annotated by a style

Instances

IsString StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

fromString :: String -> StyleDoc

Semigroup StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

(<>) :: StyleDoc -> StyleDoc -> StyleDoc

sconcat :: NonEmpty StyleDoc -> StyleDoc

stimes :: Integral b => b -> StyleDoc -> StyleDoc

Monoid StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

mempty :: StyleDoc

mappend :: StyleDoc -> StyleDoc -> StyleDoc

mconcat :: [StyleDoc] -> StyleDoc

Pretty StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

pretty :: StyleDoc -> StyleDoc

newtype StyleAnn

A style annotation.

Constructors

StyleAnn (Maybe Style)

Instances

Eq StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

(==) :: StyleAnn -> StyleAnn -> Bool

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

Show StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

showsPrec :: Int -> StyleAnn -> ShowS

show :: StyleAnn -> String

showList :: [StyleAnn] -> ShowS

Semigroup StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

(<>) :: StyleAnn -> StyleAnn -> StyleAnn

sconcat :: NonEmpty StyleAnn -> StyleAnn

stimes :: Integral b => b -> StyleAnn -> StyleAnn

Monoid StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

mempty :: StyleAnn

mappend :: StyleAnn -> StyleAnn -> StyleAnn

mconcat :: [StyleAnn] -> StyleAnn

nest :: Int -> StyleDoc -> StyleDoc

line :: StyleDoc

linebreak :: StyleDoc

group :: StyleDoc -> StyleDoc

softline :: StyleDoc

softbreak :: StyleDoc

align :: StyleDoc -> StyleDoc

hang :: Int -> StyleDoc -> StyleDoc

indent :: Int -> StyleDoc -> StyleDoc

encloseSep :: StyleDoc -> StyleDoc -> StyleDoc -> [StyleDoc] -> StyleDoc

(<+>) :: StyleDoc -> StyleDoc -> StyleDoc

hsep :: [StyleDoc] -> StyleDoc

vsep :: [StyleDoc] -> StyleDoc

fillSep :: [StyleDoc] -> StyleDoc

sep :: [StyleDoc] -> StyleDoc

hcat :: [StyleDoc] -> StyleDoc

vcat :: [StyleDoc] -> StyleDoc

fillCat :: [StyleDoc] -> StyleDoc

cat :: [StyleDoc] -> StyleDoc

punctuate :: StyleDoc -> [StyleDoc] -> [StyleDoc]

fill :: Int -> StyleDoc -> StyleDoc

fillBreak :: Int -> StyleDoc -> StyleDoc

enclose :: StyleDoc -> StyleDoc -> StyleDoc -> StyleDoc

squotes :: StyleDoc -> StyleDoc

dquotes :: StyleDoc -> StyleDoc

parens :: StyleDoc -> StyleDoc

angles :: StyleDoc -> StyleDoc

braces :: StyleDoc -> StyleDoc

brackets :: StyleDoc -> StyleDoc

indentAfterLabel :: StyleDoc -> StyleDoc

Use after a label and before the rest of what's being labelled for consistent spacingindentingetc.

For example this is used after "Warning:" in warning messages.

wordDocs :: String -> [StyleDoc]

Make a Doc from each word in a String

flow :: String -> StyleDoc

Wordwrap a String

Re-exports from RIO.PrettyPrint.Types.PrettyPrint

data Style

A style of rio-prettyprint's output.

Constructors

Error

Warning

Good

Shell

File

Url

Dir

Recommendation

Current

Target

Module

PkgComponent

Instances

Bounded Style

Defined in RIO.PrettyPrint.Types

Methods

minBound :: Style

maxBound :: Style

Enum Style

Defined in RIO.PrettyPrint.Types

Methods

succ :: Style -> Style

pred :: Style -> Style

toEnum :: Int -> Style

fromEnum :: Style -> Int

enumFrom :: Style -> [Style]

enumFromThen :: Style -> Style -> [Style]

enumFromTo :: Style -> Style -> [Style]

enumFromThenTo :: Style -> Style -> Style -> [Style]

Eq Style

Defined in RIO.PrettyPrint.Types

Methods

(==) :: Style -> Style -> Bool

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

Ord Style

Defined in RIO.PrettyPrint.Types

Methods

compare :: Style -> Style -> Ordering

(<) :: Style -> Style -> Bool

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

(>) :: Style -> Style -> Bool

(>=) :: Style -> Style -> Bool

max :: Style -> Style -> Style

min :: Style -> Style -> Style

Show Style

Defined in RIO.PrettyPrint.Types

Methods

showsPrec :: Int -> Style -> ShowS

show :: Style -> String

showList :: [Style] -> ShowS

Ix Style

Defined in RIO.PrettyPrint.Types

Methods

range :: (Style, Style) -> [Style]

index :: (Style, Style) -> Style -> Int

unsafeIndex :: (Style, Style) -> Style -> Int

inRange :: (Style, Style) -> Style -> Bool

rangeSize :: (Style, Style) -> Int

unsafeRangeSize :: (Style, Style) -> Int

Semigroup Style

The first style overrides the second.

Defined in RIO.PrettyPrint.Types

Methods

(<>) :: Style -> Style -> Style

sconcat :: NonEmpty Style -> Style

stimes :: Integral b => b -> Style -> Style