Error.Diagnose.Compat.Megaparsec

Documentation

diagnosticFromBundle

Arguments

:: forall msg s e. (IsString msg, Stream s, HasHints e msg, ShowErrorComponent e, VisualStream s, TraversableStream s)

=> (ParseError s e -> Bool)

How to decide whether this is an error or a warning diagnostic

-> Maybe msg

An optional error code

-> msg

The error message of the diagnostic

-> Maybe [Note msg]

Default hints when trivial errors are reported

-> ParseErrorBundle s e

The bundle to create a diagnostic from

-> Diagnostic msg

Transforms a megaparsec ParseErrorBundle into a well-formated Diagnostic ready to be shown.

errorDiagnosticFromBundle

Arguments

:: forall msg s e. (IsString msg, Stream s, HasHints e msg, ShowErrorComponent e, VisualStream s, TraversableStream s)

=> Maybe msg

An optional error code

-> msg

The error message of the diagnostic

-> Maybe [Note msg]

Default hints when trivial errors are reported

-> ParseErrorBundle s e

The bundle to create a diagnostic from

-> Diagnostic msg

Creates an error diagnostic from a megaparsec ParseErrorBundle.

warningDiagnosticFromBundle

Arguments

:: forall msg s e. (IsString msg, Stream s, HasHints e msg, ShowErrorComponent e, VisualStream s, TraversableStream s)

=> Maybe msg

An optional error code

-> msg

The error message of the diagnostic

-> Maybe [Note msg]

Default hints when trivial errors are reported

-> ParseErrorBundle s e

The bundle to create a diagnostic from

-> Diagnostic msg

Creates a warning diagnostic from a megaparsec ParseErrorBundle.

class HasHints e msg where

A class mapping custom errors of type e with messages of type msg.

Methods

hints :: e -> [Note msg]

Defines all the hints associated with a given custom error.