Foldable Diagnostic Source #
Instance details Defined in Error.Diagnose.Diagnostic.Internal Methods fold :: Monoid m => Diagnostic m -> m # foldMap :: Monoid m => (a -> m) -> Diagnostic a -> m # foldMap' :: Monoid m => (a -> m) -> Diagnostic a -> m # foldr :: (a -> b -> b) -> b -> Diagnostic a -> b # foldr' :: (a -> b -> b) -> b -> Diagnostic a -> b # foldl :: (b -> a -> b) -> b -> Diagnostic a -> b # foldl' :: (b -> a -> b) -> b -> Diagnostic a -> b # foldr1 :: (a -> a -> a) -> Diagnostic a -> a # foldl1 :: (a -> a -> a) -> Diagnostic a -> a # toList :: Diagnostic a -> [a] # null :: Diagnostic a -> Bool # length :: Diagnostic a -> Int # elem :: Eq a => a -> Diagnostic a -> Bool # maximum :: Ord a => Diagnostic a -> a # minimum :: Ord a => Diagnostic a -> a # sum :: Num a => Diagnostic a -> a # product :: Num a => Diagnostic a -> a #
Traversable Diagnostic Source #
Instance details Defined in Error.Diagnose.Diagnostic.Internal Methods traverse :: Applicative f => (a -> f b) -> Diagnostic a -> f (Diagnostic b) # sequenceA :: Applicative f => Diagnostic (f a) -> f (Diagnostic a) # mapM :: Monad m => (a -> m b) -> Diagnostic a -> m (Diagnostic b) # sequence :: Monad m => Diagnostic (m a) -> m (Diagnostic a) #
Functor Diagnostic Source #
Instance details Defined in Error.Diagnose.Diagnostic.Internal Methods fmap :: (a -> b) -> Diagnostic a -> Diagnostic b # (<$) :: a -> Diagnostic b -> Diagnostic a #
Monoid (Diagnostic msg) Source #
Instance details Defined in Error.Diagnose.Diagnostic.Internal Methods mempty :: Diagnostic msg # mappend :: Diagnostic msg -> Diagnostic msg -> Diagnostic msg # mconcat :: [Diagnostic msg] -> Diagnostic msg #
Semigroup (Diagnostic msg) Source #
Instance details Defined in Error.Diagnose.Diagnostic.Internal Methods (<>) :: Diagnostic msg -> Diagnostic msg -> Diagnostic msg # sconcat :: NonEmpty (Diagnostic msg) -> Diagnostic msg # stimes :: Integral b => b -> Diagnostic msg -> Diagnostic msg #

hasReports :: Diagnostic msg -> Bool Source #

Checks whether the given diagnostic has any report or not (if it is effectively empty).

reportsOf :: Diagnostic msg -> [Report msg] Source #

Retrieves the reports for this diagnostic.

warningsToErrors :: Diagnostic msg -> Diagnostic msg Source #

Transforms every warning report in this diagnostic into an error report.

errorsToWarnings :: Diagnostic msg -> Diagnostic msg Source #

Transforms every error report in this diagnostic into a warning report.

prettyDiagnostic Source #

Arguments

:: Pretty msg
=> WithUnicode	Should we use unicode when printing paths?
-> TabSize	The number of spaces each TAB character will span.
-> Diagnostic msg	The diagnostic to print.
-> Doc (Annotation ann)

Pretty prints a Diagnostic into a Document that can be output using hPutDoc.

Colors are put by default. If you do not want these, just unAnnotate the resulting document like so:

>>> let doc = unAnnotate (prettyDiagnostic withUnicode tabSize diagnostic)

Changing the style is also rather easy:

>>> let myCustomStyle :: Style = _
>>> let doc = myCustomStyle (prettyDiagnostic withUnicode tabSize diagnostic)

prettyDiagnostic' Source #

Arguments

:: WithUnicode	Should we use unicode when printing paths?
-> TabSize	The number of spaces each TAB character will span.
-> Diagnostic (Doc ann)	The diagnostic to print.
-> Doc (Annotation ann)

Like prettyDiagnostic except that instead of requiring a pretty instance for messages, this allows passing in your own Doc. Custom annotations are retained in OtherStyle

printDiagnostic Source #

Arguments

:: (MonadIO m, Pretty msg)
=> Handle	The handle onto which to output the diagnostic.
-> WithUnicode	Should we print with unicode characters?
-> TabSize	The number of spaces each TAB character will span.
-> Style ann	The style in which to output the diagnostic.
-> Diagnostic msg	The diagnostic to output.
-> m ()

Prints a Diagnostic onto a specific Handle.

printDiagnostic' Source #

Arguments

:: MonadIO m
=> Handle	The handle onto which to output the diagnostic.
-> WithUnicode	Should we print with unicode characters?
-> TabSize	The number of spaces each TAB character will span.
-> Style ann	The style in which to output the diagnostic.
-> Diagnostic (Doc ann)	The diagnostic to output.
-> m ()

Like printDiagnostic except that instead of requiring a pretty instance for messages, this allows passing in your own Doc.

addFile Source #

Arguments

:: Diagnostic msg
-> FilePath	The path to the file.
-> String	The content of the file as a single string, where lines are ended by `\n`.
-> Diagnostic msg

Inserts a new referenceable file within the diagnostic.

addReport Source #

Arguments

:: Diagnostic msg
-> Report msg	The new report to add to the diagnostic.
-> Diagnostic msg

Inserts a new report into a diagnostic.