Dhall.LSP.Backend.Diagnostics

Documentation

data DhallError

A Dhall error. Covers parsing, resolving of imports, typechecking and normalisation.

diagnose :: DhallError -> [Diagnosis]

Give a short diagnosis for a given error that can be shown to the end user.

data Diagnosis

A diagnosis, optionally tagged with a source code range.

Constructors

Diagnosis

Fields

• doctor :: Text

  Where the diagnosis came from, e.g. Dhall.TypeCheck.

• range :: Maybe Range

  The range of code the diagnosis concerns

• diagnosis :: Text

explain :: DhallError -> Maybe Diagnosis

Give a detailed explanation for the given error; if no detailed explanation is available return Nothing instead.

embedsWithRanges :: Expr Src a -> [(Range, a)]

Collect all Embed constructors (i.e. imports if the expression has type `Expr Src Import`) wrapped in a Note constructor and return them together with their associated range in the source code.

offsetToPosition :: Text -> Int -> Position

type Position = (Int, Int)

A (line, col) pair representing a position in a source file; 0-based.

positionFromMegaparsec :: SourcePos -> Position

positionToOffset :: Text -> Position -> Int

data Range

A source code range.

Constructors

Range

Fields

• left, right :: Position

rangeFromDhall :: Src -> Range

Convert a source range from Dhalls Src format. The returned range is "tight", that is, does not contain any trailing whitespace.

subtractPosition :: Position -> Position -> Position

addRelativePosition pos (subtractPosition pos pos') == pos'