Safe Haskell | None |
---|---|
Language | Haskell2010 |
Stack.PrettyPrint
Contents
Synopsis
- displayPlain :: Display a => Int -> a -> Text
- displayWithColor :: (HasRunner env, Display a, HasAnsiAnn (Ann a), MonadReader env m, HasLogFunc env, HasCallStack) => a -> m Text
- prettyDebug :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m ()
- prettyInfo :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m ()
- prettyNote :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m ()
- prettyWarn :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m ()
- prettyError :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m ()
- prettyWarnNoIndent :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m ()
- prettyErrorNoIndent :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m ()
- prettyDebugL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m ()
- prettyInfoL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m ()
- prettyNoteL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m ()
- prettyWarnL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m ()
- prettyErrorL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m ()
- prettyWarnNoIndentL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m ()
- prettyErrorNoIndentL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m ()
- prettyDebugS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m ()
- prettyInfoS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m ()
- prettyNoteS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m ()
- prettyWarnS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m ()
- prettyErrorS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m ()
- prettyWarnNoIndentS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m ()
- prettyErrorNoIndentS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m ()
- styleWarning :: AnsiDoc -> AnsiDoc
- styleError :: AnsiDoc -> AnsiDoc
- styleGood :: AnsiDoc -> AnsiDoc
- styleShell :: AnsiDoc -> AnsiDoc
- styleFile :: AnsiDoc -> AnsiDoc
- styleUrl :: AnsiDoc -> AnsiDoc
- styleDir :: AnsiDoc -> AnsiDoc
- styleModule :: AnsiDoc -> AnsiDoc
- styleCurrent :: AnsiDoc -> AnsiDoc
- styleTarget :: AnsiDoc -> AnsiDoc
- styleRecommendation :: AnsiDoc -> AnsiDoc
- displayMilliseconds :: Double -> AnsiDoc
- bulletedList :: [AnsiDoc] -> AnsiDoc
- spacedBulletedList :: [AnsiDoc] -> AnsiDoc
- debugBracket :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m, MonadUnliftIO m) => Doc AnsiAnn -> m a -> m a
- class Display a where
- type AnsiDoc = Doc AnsiAnn
- newtype AnsiAnn = AnsiAnn [SGR]
- class HasAnsiAnn a where
- getAnsiAnn :: a -> AnsiAnn
- toAnsiDoc :: Doc a -> AnsiDoc
- data Doc a
- nest :: Int -> Doc a -> Doc a
- line :: Doc a
- linebreak :: Doc a
- group :: Doc a -> Doc a
- softline :: Doc a
- softbreak :: Doc a
- align :: Doc a -> Doc a
- hang :: Int -> Doc a -> Doc a
- indent :: Int -> Doc a -> Doc a
- encloseSep :: Doc a -> Doc a -> Doc a -> [Doc a] -> Doc a
- (<+>) :: Doc a -> Doc a -> Doc a
- hsep :: [Doc a] -> Doc a
- vsep :: [Doc a] -> Doc a
- fillSep :: [Doc a] -> Doc a
- sep :: [Doc a] -> Doc a
- hcat :: [Doc a] -> Doc a
- vcat :: [Doc a] -> Doc a
- fillCat :: [Doc a] -> Doc a
- cat :: [Doc a] -> Doc a
- punctuate :: Doc a -> [Doc a] -> [Doc a]
- fill :: Int -> Doc a -> Doc a
- fillBreak :: Int -> Doc a -> Doc a
- enclose :: Doc a -> Doc a -> Doc a -> Doc a
- squotes :: Doc a -> Doc a
- dquotes :: Doc a -> Doc a
- parens :: Doc a -> Doc a
- angles :: Doc a -> Doc a
- braces :: Doc a -> Doc a
- brackets :: Doc a -> Doc a
- indentAfterLabel :: Doc a -> Doc a
- wordDocs :: String -> [Doc a]
- flow :: String -> Doc a
Pretty printing functions
displayWithColor :: (HasRunner env, Display a, HasAnsiAnn (Ann a), MonadReader env m, HasLogFunc env, HasCallStack) => a -> m Text Source #
Logging based on pretty-print typeclass
prettyDebug :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m () Source #
prettyInfo :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m () Source #
prettyNote :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m () Source #
prettyWarn :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m () Source #
prettyError :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m () Source #
prettyWarnNoIndent :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m () Source #
prettyErrorNoIndent :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => Doc AnsiAnn -> m () Source #
prettyDebugL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m () Source #
prettyInfoL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m () Source #
prettyNoteL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m () Source #
prettyWarnL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m () Source #
prettyErrorL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m () Source #
prettyWarnNoIndentL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m () Source #
prettyErrorNoIndentL :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => [Doc AnsiAnn] -> m () Source #
prettyDebugS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m () Source #
prettyInfoS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m () Source #
prettyNoteS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m () Source #
prettyWarnS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m () Source #
prettyErrorS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m () Source #
prettyWarnNoIndentS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m () Source #
prettyErrorNoIndentS :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m) => String -> m () Source #
Semantic styling functions
These are preferred to styling or colors directly, so that we can encourage consistency.
styleWarning :: AnsiDoc -> AnsiDoc Source #
Style an AnsiDoc
as a warning. Should be used sparingly, not to style
entire long messages. For example, it's used to style the "Warning:"
label for an error message, not the entire message.
styleError :: AnsiDoc -> AnsiDoc Source #
Style an AnsiDoc
as an error. Should be used sparingly, not to style
entire long messages. For example, it's used to style the "Error:"
label for an error message, not the entire message.
styleGood :: AnsiDoc -> AnsiDoc Source #
Style an AnsiDoc
in a way to emphasize that it is a particularly good
thing.
styleShell :: AnsiDoc -> AnsiDoc Source #
Style an AnsiDoc
as a shell command, i.e. when suggesting something
to the user that should be typed in directly as written.
styleUrl :: AnsiDoc -> AnsiDoc Source #
Style an AsciDoc
as a URL. For now using the same style as files.
styleCurrent :: AnsiDoc -> AnsiDoc Source #
Style an AnsiDoc
in a way that emphasizes that it is related to
a current thing. For example, could be used when talking about the
current package we're processing when outputting the name of it.
styleTarget :: AnsiDoc -> AnsiDoc Source #
styleRecommendation :: AnsiDoc -> AnsiDoc Source #
Style used to highlight part of a recommended course of action.
displayMilliseconds :: Double -> AnsiDoc Source #
Formatting utils
spacedBulletedList :: [AnsiDoc] -> AnsiDoc Source #
Display a bulleted list of AnsiDoc
with a blank line between
each.
debugBracket :: (HasCallStack, HasRunner env, MonadReader env m, MonadIO m, MonadUnliftIO m) => Doc AnsiAnn -> m a -> m a Source #
Re-exports from Text.PrettyPrint.Leijen.Extended
class Display a where Source #
Minimal complete definition
Nothing
Instances
Display ModuleName Source # | |
Defined in Stack.PrettyPrint Associated Types type Ann ModuleName :: Type Source # Methods display :: ModuleName -> Doc (Ann ModuleName) Source # | |
Display PackageName Source # | |
Defined in Stack.PrettyPrint Associated Types type Ann PackageName :: Type Source # Methods display :: PackageName -> Doc (Ann PackageName) Source # | |
Display Version Source # | |
Display PackageIdentifier Source # | |
Defined in Stack.PrettyPrint Associated Types type Ann PackageIdentifier :: Type Source # Methods display :: PackageIdentifier -> Doc (Ann PackageIdentifier) Source # | |
Display (Doc a) Source # | |
Display (PackageName, NamedComponent) Source # | |
Defined in Stack.PrettyPrint Associated Types type Ann (PackageName, NamedComponent) :: Type Source # Methods display :: (PackageName, NamedComponent) -> Doc (Ann (PackageName, NamedComponent)) Source # | |
Display (Path b Dir) Source # | |
Display (Path b File) Source # | |
Constructors
AnsiAnn [SGR] |
class HasAnsiAnn a where Source #
Minimal complete definition
Instances
HasAnsiAnn () Source # | |
Defined in Text.PrettyPrint.Leijen.Extended | |
HasAnsiAnn AnsiAnn Source # | |
indentAfterLabel :: Doc a -> Doc a Source #
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.
Orphan instances
Display ModuleName Source # | |
Associated Types type Ann ModuleName :: Type Source # Methods display :: ModuleName -> Doc (Ann ModuleName) Source # | |
Display PackageName Source # | |
Associated Types type Ann PackageName :: Type Source # Methods display :: PackageName -> Doc (Ann PackageName) Source # | |
Display Version Source # | |
Display PackageIdentifier Source # | |
Associated Types type Ann PackageIdentifier :: Type Source # Methods display :: PackageIdentifier -> Doc (Ann PackageIdentifier) Source # | |
Display (PackageName, NamedComponent) Source # | |
Associated Types type Ann (PackageName, NamedComponent) :: Type Source # Methods display :: (PackageName, NamedComponent) -> Doc (Ann (PackageName, NamedComponent)) Source # | |
Display (Path b Dir) Source # | |
Display (Path b File) Source # | |