haskell-language-server-2.11.0.0: LSP server for GHC
Safe HaskellNone
LanguageGHC2021

Ide.Plugin.Cabal.Diagnostics

Contents

Synopsis

Documentation

errorDiagnostic :: NormalizedFilePath -> PError -> FileDiagnostic Source #

Produce a diagnostic from a Cabal parser error

warningDiagnostic :: NormalizedFilePath -> PWarning -> FileDiagnostic Source #

Produce a diagnostic from a Cabal parser warning

positionFromCabalPosition :: Position -> Position Source #

Convert a Position from Cabal to a Range that LSP understands.

Prefer this function over hand-rolled unpacking/packing, since LSP is zero-based, while Cabal is one-based.

>>> positionFromCabalPosition $ Lib.Position 1 1
Position 0 0

fatalParseErrorDiagnostic :: NormalizedFilePath -> Text -> FileDiagnostic Source #

Produce a diagnostic for a fatal Cabal parser error.

Re-exports

data FileDiagnostic #

Human readable diagnostics for a specific file.

This type packages a pretty printed, human readable error message along with the related source location so that we can display the error on either the console or in the IDE at the right source location.

It also optionally keeps a structured diagnostic message GhcMessage in StructuredMessage.

Instances

Instances details
Generic FileDiagnostic 
Instance details

Defined in Development.IDE.Types.Diagnostics

Associated Types

type Rep FileDiagnostic 
Instance details

Defined in Development.IDE.Types.Diagnostics

type Rep FileDiagnostic = D1 ('MetaData "FileDiagnostic" "Development.IDE.Types.Diagnostics" "ghcide-2.11.0.0-9D0mb1AUSEg84T2uc4L6bj" 'False) (C1 ('MetaCons "FileDiagnostic" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fdFilePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NormalizedFilePath) :*: S1 ('MetaSel ('Just "fdShouldShowDiagnostic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShowDiagnostic)) :*: (S1 ('MetaSel ('Just "fdLspDiagnostic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Diagnostic) :*: S1 ('MetaSel ('Just "fdStructuredMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StructuredMessage))))

Methods

from :: FileDiagnostic -> Rep FileDiagnostic x #

to :: Rep FileDiagnostic x -> FileDiagnostic #

Show FileDiagnostic 
Instance details

Defined in Development.IDE.Types.Diagnostics

Methods

showsPrec :: Int -> FileDiagnostic -> ShowS #

show :: FileDiagnostic -> String #

showList :: [FileDiagnostic] -> ShowS #

NFData FileDiagnostic 
Instance details

Defined in Development.IDE.Types.Diagnostics

Methods

rnf :: FileDiagnostic -> () #

Eq FileDiagnostic 
Instance details

Defined in Development.IDE.Types.Diagnostics

Methods

(==) :: FileDiagnostic -> FileDiagnostic -> Bool #

(/=) :: FileDiagnostic -> FileDiagnostic -> Bool #

Ord FileDiagnostic 
Instance details

Defined in Development.IDE.Types.Diagnostics

Methods

compare :: FileDiagnostic -> FileDiagnostic -> Ordering #

(<) :: FileDiagnostic -> FileDiagnostic -> Bool #

(<=) :: FileDiagnostic -> FileDiagnostic -> Bool #

(>) :: FileDiagnostic -> FileDiagnostic -> Bool #

(>=) :: FileDiagnostic -> FileDiagnostic -> Bool #

max :: FileDiagnostic -> FileDiagnostic -> FileDiagnostic #

min :: FileDiagnostic -> FileDiagnostic -> FileDiagnostic #

type Rep FileDiagnostic 
Instance details

Defined in Development.IDE.Types.Diagnostics

type Rep FileDiagnostic = D1 ('MetaData "FileDiagnostic" "Development.IDE.Types.Diagnostics" "ghcide-2.11.0.0-9D0mb1AUSEg84T2uc4L6bj" 'False) (C1 ('MetaCons "FileDiagnostic" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fdFilePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NormalizedFilePath) :*: S1 ('MetaSel ('Just "fdShouldShowDiagnostic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShowDiagnostic)) :*: (S1 ('MetaSel ('Just "fdLspDiagnostic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Diagnostic) :*: S1 ('MetaSel ('Just "fdStructuredMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StructuredMessage))))

data Diagnostic #

Constructors

Diagnostic 

Fields

Instances

Instances details
FromJSON Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

parseJSON :: Value -> Parser Diagnostic #

parseJSONList :: Value -> Parser [Diagnostic] #

omittedField :: Maybe Diagnostic #

ToJSON Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

toJSON :: Diagnostic -> Value #

toEncoding :: Diagnostic -> Encoding #

toJSONList :: [Diagnostic] -> Value #

toEncodingList :: [Diagnostic] -> Encoding #

omitField :: Diagnostic -> Bool #

Generic Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Associated Types

type Rep Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

type Rep Diagnostic = D1 ('MetaData "Diagnostic" "Language.LSP.Protocol.Internal.Types.Diagnostic" "lsp-types-2.3.0.1-25mMreyTkQ2H8Rsux8iEVM" 'False) (C1 ('MetaCons "Diagnostic" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Range) :*: S1 ('MetaSel ('Just "_severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiagnosticSeverity))) :*: (S1 ('MetaSel ('Just "_code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Int32 |? Text))) :*: S1 ('MetaSel ('Just "_codeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeDescription)))) :*: ((S1 ('MetaSel ('Just "_source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "_tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DiagnosticTag])) :*: (S1 ('MetaSel ('Just "_relatedInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DiagnosticRelatedInformation])) :*: S1 ('MetaSel ('Just "_data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Value)))))))

Methods

from :: Diagnostic -> Rep Diagnostic x #

to :: Rep Diagnostic x -> Diagnostic #

Show Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

showsPrec :: Int -> Diagnostic -> ShowS #

show :: Diagnostic -> String #

showList :: [Diagnostic] -> ShowS #

NFData Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

rnf :: Diagnostic -> () #

Eq Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

(==) :: Diagnostic -> Diagnostic -> Bool #

(/=) :: Diagnostic -> Diagnostic -> Bool #

Ord Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

compare :: Diagnostic -> Diagnostic -> Ordering #

(<) :: Diagnostic -> Diagnostic -> Bool #

(<=) :: Diagnostic -> Diagnostic -> Bool #

(>) :: Diagnostic -> Diagnostic -> Bool #

(>=) :: Diagnostic -> Diagnostic -> Bool #

max :: Diagnostic -> Diagnostic -> Diagnostic #

min :: Diagnostic -> Diagnostic -> Diagnostic #

Hashable Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

hashWithSalt :: Int -> Diagnostic -> Int #

hash :: Diagnostic -> Int #

Pretty Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

Methods

pretty :: Diagnostic -> Doc ann #

prettyList :: [Diagnostic] -> Doc ann #

HasMessage Diagnostic Text 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

message :: Lens' Diagnostic Text

HasRange Diagnostic Range 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

range :: Lens' Diagnostic Range

HasCode Diagnostic (Maybe (Int32 |? Text)) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

code :: Lens' Diagnostic (Maybe (Int32 |? Text))

HasCodeDescription Diagnostic (Maybe CodeDescription) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

codeDescription :: Lens' Diagnostic (Maybe CodeDescription)

HasData_ Diagnostic (Maybe Value) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

data_ :: Lens' Diagnostic (Maybe Value)

HasDiagnostics CodeAction (Maybe [Diagnostic]) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

diagnostics :: Lens' CodeAction (Maybe [Diagnostic])

HasDiagnostics CodeActionContext [Diagnostic] 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

diagnostics :: Lens' CodeActionContext [Diagnostic]

HasDiagnostics PublishDiagnosticsParams [Diagnostic] 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

diagnostics :: Lens' PublishDiagnosticsParams [Diagnostic]

HasItems FullDocumentDiagnosticReport [Diagnostic] 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

items :: Lens' FullDocumentDiagnosticReport [Diagnostic]

HasItems RelatedFullDocumentDiagnosticReport [Diagnostic] 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

items :: Lens' RelatedFullDocumentDiagnosticReport [Diagnostic]

HasItems WorkspaceFullDocumentDiagnosticReport [Diagnostic] 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

items :: Lens' WorkspaceFullDocumentDiagnosticReport [Diagnostic]

HasRelatedInformation Diagnostic (Maybe [DiagnosticRelatedInformation]) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

relatedInformation :: Lens' Diagnostic (Maybe [DiagnosticRelatedInformation])

HasSeverity Diagnostic (Maybe DiagnosticSeverity) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

severity :: Lens' Diagnostic (Maybe DiagnosticSeverity)

HasSource Diagnostic (Maybe Text) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

source :: Lens' Diagnostic (Maybe Text)

HasTags Diagnostic (Maybe [DiagnosticTag]) 
Instance details

Defined in Language.LSP.Protocol.Types.Lens

Methods

tags :: Lens' Diagnostic (Maybe [DiagnosticTag])

type Rep Diagnostic 
Instance details

Defined in Language.LSP.Protocol.Internal.Types.Diagnostic

type Rep Diagnostic = D1 ('MetaData "Diagnostic" "Language.LSP.Protocol.Internal.Types.Diagnostic" "lsp-types-2.3.0.1-25mMreyTkQ2H8Rsux8iEVM" 'False) (C1 ('MetaCons "Diagnostic" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Range) :*: S1 ('MetaSel ('Just "_severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiagnosticSeverity))) :*: (S1 ('MetaSel ('Just "_code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Int32 |? Text))) :*: S1 ('MetaSel ('Just "_codeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeDescription)))) :*: ((S1 ('MetaSel ('Just "_source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "_tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DiagnosticTag])) :*: (S1 ('MetaSel ('Just "_relatedInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DiagnosticRelatedInformation])) :*: S1 ('MetaSel ('Just "_data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Value)))))))