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

Instances

HasTerm SimplePrettyApp

Defined in RIO.PrettyPrint.Simple

Methods

useColorL :: Lens' SimplePrettyApp Bool

termWidthL :: Lens' SimplePrettyApp Int

class HasStylesUpdate env where

Environment values with a styles update.

Since: 0.1.0.0

Methods

stylesUpdateL :: Lens' env StylesUpdate

Instances

HasStylesUpdate SimplePrettyApp

Defined in RIO.PrettyPrint.Simple

Methods

stylesUpdateL :: Lens' SimplePrettyApp StylesUpdate

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

logLevelToStyle :: LogLevel -> Style

The Style intended to be associated with a LogLevel.

Since: 0.1.1.0

Formatting utils

bulletedList :: [StyleDoc] -> StyleDoc

Display a bulleted list of StyleDoc.

mkNarrativeList

Arguments

:: Pretty a

=> Maybe Style

Style the items in the list?

-> Bool

Use a serial comma?

-> [a]

-> [StyleDoc]

A helper function to yield a narrative list from a list of items, with a final fullstop. For example, helps produce the output "apple, ball and cat." (no serial comma) or "apple, ball, and cat." (serial comma) from ["apple", "ball", "cat"].

Since: 0.1.4.0

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

default pretty :: Show a => a -> StyleDoc

Instances

Pretty ModuleName

Defined in Text.PrettyPrint.Leijen.Extended

Methods

pretty :: ModuleName -> StyleDoc

Pretty PrettyException

Defined in RIO.PrettyPrint.PrettyException

Methods

pretty :: PrettyException -> 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

Monoid StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

mempty :: StyleDoc

mappend :: StyleDoc -> StyleDoc -> StyleDoc

mconcat :: [StyleDoc] -> StyleDoc

Semigroup StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

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

sconcat :: NonEmpty StyleDoc -> StyleDoc

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

Show StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

showsPrec :: Int -> StyleDoc -> ShowS

show :: StyleDoc -> String

showList :: [StyleDoc] -> ShowS

Pretty StyleDoc

Defined in Text.PrettyPrint.Leijen.Extended

Methods

pretty :: StyleDoc -> StyleDoc

newtype StyleAnn

A style annotation.

Constructors

StyleAnn (Maybe Style)

Instances

Monoid StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

mempty :: StyleAnn

mappend :: StyleAnn -> StyleAnn -> StyleAnn

mconcat :: [StyleAnn] -> StyleAnn

Semigroup StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

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

sconcat :: NonEmpty StyleAnn -> StyleAnn

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

Show StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

showsPrec :: Int -> StyleAnn -> ShowS

show :: StyleAnn -> String

showList :: [StyleAnn] -> ShowS

Eq StyleAnn

Defined in Text.PrettyPrint.Leijen.Extended

Methods

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

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

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

string :: String -> StyleDoc

The document string s concatenates all characters in s using line for newline characters and char for all other characters. It is used whenever the text contains newline characters.

Since: 0.1.4.0

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

Info

Debug

OtherLevel

Good

Shell

File

Url

Dir

Recommendation

Current

Target

Module

PkgComponent

Secondary

Highlight

Instances

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

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]

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

Show Style

Defined in RIO.PrettyPrint.Types

Methods

showsPrec :: Int -> Style -> ShowS

show :: Style -> String

showList :: [Style] -> ShowS

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