Language.PureScript.Errors

Documentation

module Language.PureScript.AST

newtype ErrorSuggestion

Constructors

ErrorSuggestion Text

errorSpan :: ErrorMessage -> Maybe (NonEmpty SourceSpan)

Get the source span for an error

errorModule :: ErrorMessage -> Maybe ModuleName

Get the module name for an error

findHint :: (ErrorMessageHint -> Maybe a) -> ErrorMessage -> Maybe a

stripModuleAndSpan :: ErrorMessage -> ErrorMessage

Remove the module name and span hints from an error

errorCode :: ErrorMessage -> Text

Get the error code for a particular error type

newtype MultipleErrors

A stack trace for an error

Constructors

MultipleErrors

Fields

• runMultipleErrors :: [ErrorMessage]

Instances

Show MultipleErrors

Methods

showsPrec :: Int -> MultipleErrors -> ShowS

show :: MultipleErrors -> String

showList :: [MultipleErrors] -> ShowS

Monoid MultipleErrors

Methods

mempty :: MultipleErrors

mappend :: MultipleErrors -> MultipleErrors -> MultipleErrors

mconcat :: [MultipleErrors] -> MultipleErrors

MonadError MultipleErrors Make

Methods

throwError :: MultipleErrors -> Make a

catchError :: Make a -> (MultipleErrors -> Make a) -> Make a

MonadWriter MultipleErrors Make

Methods

writer :: (a, MultipleErrors) -> Make a

tell :: MultipleErrors -> Make ()

listen :: Make a -> Make (a, MultipleErrors)

pass :: Make (a, MultipleErrors -> MultipleErrors) -> Make a

nonEmpty :: MultipleErrors -> Bool

Check whether a collection of errors is empty or not.

errorMessage :: SimpleErrorMessage -> MultipleErrors

Create an error set from a single simple error message

errorMessage' :: SourceSpan -> SimpleErrorMessage -> MultipleErrors

Create an error set from a single simple error message and source annotation

errorMessage'' :: NonEmpty SourceSpan -> SimpleErrorMessage -> MultipleErrors

Create an error set from a single simple error message and source annotations

singleError :: ErrorMessage -> MultipleErrors

Create an error set from a single error message

onErrorMessages :: (ErrorMessage -> ErrorMessage) -> MultipleErrors -> MultipleErrors

Lift a function on ErrorMessage to a function on MultipleErrors

addHint :: ErrorMessageHint -> MultipleErrors -> MultipleErrors

Add a hint to an error message

addHints :: [ErrorMessageHint] -> MultipleErrors -> MultipleErrors

Add hints to an error message

data TypeMap

A map from rigid type variable name/unknown variable pairs to new variables.

Constructors

TypeMap

Fields

• umSkolemMap :: Map Int (String, Int, Maybe SourceSpan)

  a map from skolems to their new names, including source and naming info

• umUnknownMap :: Map Int Int

  a map from unification variables to their new names

• umNextIndex :: Int

  unknowns and skolems share a source of names during renaming, to avoid overlaps in error messages. This is the next label for either case.

Instances

Show TypeMap

Methods

showsPrec :: Int -> TypeMap -> ShowS

show :: TypeMap -> String

showList :: [TypeMap] -> ShowS

defaultUnknownMap :: TypeMap

data Level

How critical the issue is

Constructors

Error

Warning

Instances

Show Level

Methods

showsPrec :: Int -> Level -> ShowS

show :: Level -> String

showList :: [Level] -> ShowS

unwrapErrorMessage :: ErrorMessage -> SimpleErrorMessage

Extract nested error messages from wrapper errors

replaceUnknowns :: Type -> State TypeMap Type

onTypesInErrorMessage :: (Type -> Type) -> ErrorMessage -> ErrorMessage

onTypesInErrorMessageM :: Applicative m => (Type -> m Type) -> ErrorMessage -> m ErrorMessage

errorDocUri :: ErrorMessage -> Text

errorSuggestion :: SimpleErrorMessage -> Maybe ErrorSuggestion

suggestionSpan :: ErrorMessage -> Maybe SourceSpan

showSuggestion :: SimpleErrorMessage -> Text

ansiColor :: (ColorIntensity, Color) -> String

ansiColorReset :: String

colorCode :: Maybe (ColorIntensity, Color) -> Text -> Text

colorCodeBox :: Maybe (ColorIntensity, Color) -> Box -> Box

defaultCodeColor :: (ColorIntensity, Color)

Default color intesity and color for code

data PPEOptions

prettyPrintSingleError Options

Constructors

PPEOptions

Fields

• ppeCodeColor :: Maybe (ColorIntensity, Color)

  Color code with this color... or not

• ppeFull :: Bool

  Should write a full error message?

• ppeLevel :: Level

  Should this report an error or a warning?

• ppeShowDocs :: Bool

  Should show a link to error message's doc page?

• ppeRelativeDirectory :: FilePath

  FilePath to which the errors are relative

defaultPPEOptions :: PPEOptions

Default options for PPEOptions

prettyPrintSingleError :: PPEOptions -> ErrorMessage -> Box

Pretty print a single error, simplifying if necessary

prettyPrintExport :: DeclarationRef -> Text

prettyPrintImport :: ModuleName -> ImportDeclarationType -> Maybe ModuleName -> Text

prettyPrintRef :: DeclarationRef -> Maybe Text

prettyPrintMultipleErrors :: PPEOptions -> MultipleErrors -> String

Pretty print multiple errors

prettyPrintMultipleWarnings :: PPEOptions -> MultipleErrors -> String

Pretty print multiple warnings

prettyPrintMultipleWarningsBox :: PPEOptions -> MultipleErrors -> [Box]

Pretty print warnings as a Box

prettyPrintMultipleErrorsBox :: PPEOptions -> MultipleErrors -> [Box]

Pretty print errors as a Box

prettyPrintMultipleErrorsWith :: PPEOptions -> String -> String -> MultipleErrors -> [Box]

prettyPrintParseError :: ParseError -> Box

Pretty print a Parsec ParseError as a Box

prettyPrintParseErrorMessages :: String -> String -> String -> String -> String -> [Message] -> Box

Pretty print ParseError detail messages.

Adapted from showErrorMessages. See https://github.com/aslatter/parsec/blob/v3.1.9/Text/Parsec/Error.hs#L173.

indent :: Box -> Box

Indent to the right, and pad on top and bottom.

line :: Text -> Box

lineS :: String -> Box

renderBox :: Box -> String

toTypelevelString :: Type -> Maybe Box

rethrow :: MonadError e m => (e -> e) -> m a -> m a

Rethrow an error with a more detailed error message in the case of failure

reifyErrors :: MonadError e m => m a -> m (Either e a)

reflectErrors :: MonadError e m => m (Either e a) -> m a

warnAndRethrow :: (MonadError e m, MonadWriter e m) => (e -> e) -> m a -> m a

rethrowWithPosition :: MonadError MultipleErrors m => SourceSpan -> m a -> m a

Rethrow an error with source position information

warnWithPosition :: MonadWriter MultipleErrors m => SourceSpan -> m a -> m a

warnAndRethrowWithPosition :: (MonadError MultipleErrors m, MonadWriter MultipleErrors m) => SourceSpan -> m a -> m a

withPosition :: SourceSpan -> ErrorMessage -> ErrorMessage

positionedError :: SourceSpan -> ErrorMessageHint

escalateWarningWhen :: (MonadWriter MultipleErrors m, MonadError MultipleErrors m) => (ErrorMessage -> Bool) -> m a -> m a

Runs a computation listening for warnings and then escalating any warnings that match the predicate to error status.

parU :: forall m a b. MonadError MultipleErrors m => [a] -> (a -> m b) -> m [b]

Collect errors in in parallel