Error.Diagnose.Report

Re-exports

data Note msg

A note is a piece of information that is found at the end of a report.

Constructors

Note msg

A note, which is meant to give valuable information related to the encountered error.

Hint msg

A hint, to propose potential fixes or help towards fixing the issue.

Instances

IsString msg => IsString (Note msg)

Constructs a Note from the given message as a literal string.

Defined in Error.Diagnose.Report.Internal

Methods

fromString :: String -> Note msg

data Marker msg

The type of markers with abstract message type, shown under code lines.

Constructors

This msg

A red or yellow marker under source code, marking important parts of the code.

Where msg

A blue marker symbolizing additional information.

Maybe msg

A magenta marker to report potential fixes.

Blank

An empty marker, whose sole purpose is to include a line of code in the report without markers under.

Instances

Eq (Marker msg)

Defined in Error.Diagnose.Report.Internal

Methods

(==) :: Marker msg -> Marker msg -> Bool

(/=) :: Marker msg -> Marker msg -> Bool

Ord (Marker msg)

Defined in Error.Diagnose.Report.Internal

Methods

compare :: Marker msg -> Marker msg -> Ordering

(<) :: Marker msg -> Marker msg -> Bool

(<=) :: Marker msg -> Marker msg -> Bool

(>) :: Marker msg -> Marker msg -> Bool

(>=) :: Marker msg -> Marker msg -> Bool

max :: Marker msg -> Marker msg -> Marker msg

min :: Marker msg -> Marker msg -> Marker msg

data Report msg

The type of diagnostic reports with abstract message type.

Instances

Semigroup msg => Semigroup (Report msg)

Defined in Error.Diagnose.Report.Internal

Methods

(<>) :: Report msg -> Report msg -> Report msg

sconcat :: NonEmpty (Report msg) -> Report msg

stimes :: Integral b => b -> Report msg -> Report msg

Monoid msg => Monoid (Report msg)

Defined in Error.Diagnose.Report.Internal

Methods

mempty :: Report msg

mappend :: Report msg -> Report msg -> Report msg

mconcat :: [Report msg] -> Report msg

warn

Arguments

:: Maybe msg

An optional error code to be shown right next to "error" or "warning".

-> msg

The report message, shown at the very top.

-> [(Position, Marker msg)]

A list associating positions with markers.

-> [Note msg]

A possibly mempty list of hints to add at the end of the report.

-> Report msg

Constructs a warning or an error report.

err

Arguments

:: Maybe msg

An optional error code to be shown right next to "error" or "warning".

-> msg

The report message, shown at the very top.

-> [(Position, Marker msg)]

A list associating positions with markers.

-> [Note msg]

A possibly mempty list of hints to add at the end of the report.

-> Report msg

Constructs a warning or an error report.

warningToError :: Report msg -> Report msg

Transforms a warning report into an error report.

errorToWarning :: Report msg -> Report msg

Transforms an error report into a warning report.