ghcide-0.7.5.0: The core of an IDE
Safe HaskellNone
LanguageHaskell2010

Development.IDE.Types.Diagnostics

Synopsis

Documentation

data Diagnostic #

Instances

Instances details
Eq Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

Ord Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

Read Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

Show Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

Generic Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

Associated Types

type Rep Diagnostic :: Type -> Type #

ToJSON Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

FromJSON Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

NFData Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

Methods

rnf :: Diagnostic -> () #

HasMessage Diagnostic Text 
Instance details

Defined in Language.LSP.Types.Lens

HasRange Diagnostic Range 
Instance details

Defined in Language.LSP.Types.Lens

HasRelatedInformation Diagnostic (Maybe (List DiagnosticRelatedInformation)) 
Instance details

Defined in Language.LSP.Types.Lens

HasSeverity Diagnostic (Maybe DiagnosticSeverity) 
Instance details

Defined in Language.LSP.Types.Lens

HasSource Diagnostic (Maybe DiagnosticSource) 
Instance details

Defined in Language.LSP.Types.Lens

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

Defined in Language.LSP.Types.Lens

HasDiagnostics CodeAction (Maybe (List Diagnostic)) 
Instance details

Defined in Language.LSP.Types.Lens

HasDiagnostics CodeActionContext (List Diagnostic) 
Instance details

Defined in Language.LSP.Types.Lens

HasDiagnostics PublishDiagnosticsParams (List Diagnostic) 
Instance details

Defined in Language.LSP.Types.Lens

HasTags Diagnostic (Maybe (List DiagnosticTag)) 
Instance details

Defined in Language.LSP.Types.Lens

type Rep Diagnostic 
Instance details

Defined in Language.LSP.Types.Diagnostic

data ShowDiagnostic Source #

Defines whether a particular diagnostic should be reported back to the user.

One important use case is "missing signature" code lenses, for which we need to enable the corresponding warning during type checking. However, we do not want to show the warning unless the programmer asks for it (#261).

Constructors

ShowDiag

Report back to the user

HideDiag

Hide from user

type FileDiagnostic = (NormalizedFilePath, ShowDiagnostic, Diagnostic) Source #

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.

type IdeResult v = ([FileDiagnostic], Maybe v) Source #

The result of an IDE operation. Warnings and errors are in the Diagnostic, and a value is in the Maybe. For operations that throw an error you expect a non-empty list of diagnostics, at least one of which is an error, and a Nothing. For operations that succeed you expect perhaps some warnings and a Just. For operations that depend on other failing operations you may get empty diagnostics and a Nothing, to indicate this phase throws no fresh errors but still failed.

A rule on a file should only return diagnostics for that given file. It should not propagate diagnostic errors through multiple phases.

data DiagnosticSeverity #

Constructors

DsError

Error = 1,

DsWarning

Warning = 2,

DsInfo

Info = 3,

DsHint

Hint = 4

Instances

Instances details
Eq DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

Ord DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

Read DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

Show DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

Generic DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

Associated Types

type Rep DiagnosticSeverity :: Type -> Type #

ToJSON DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

FromJSON DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

NFData DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

Methods

rnf :: DiagnosticSeverity -> () #

HasSeverity Diagnostic (Maybe DiagnosticSeverity) 
Instance details

Defined in Language.LSP.Types.Lens

type Rep DiagnosticSeverity 
Instance details

Defined in Language.LSP.Types.Diagnostic

type Rep DiagnosticSeverity = D1 ('MetaData "DiagnosticSeverity" "Language.LSP.Types.Diagnostic" "lsp-types-1.1.0.0-49IPbTxRu66JZc3LjJqiaC" 'False) ((C1 ('MetaCons "DsError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DsWarning" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DsInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DsHint" 'PrefixI 'False) (U1 :: Type -> Type)))

newtype List a #

All LSP types representing a list **must** use this type rather than '[]'. In particular this is necessary to change the FromJSON instance to be compatible with Elisp (where empty lists show up as null)

Constructors

List [a] 

Instances

Instances details
Functor List 
Instance details

Defined in Language.LSP.Types.Common

Methods

fmap :: (a -> b) -> List a -> List b #

(<$) :: a -> List b -> List a #

Foldable List 
Instance details

Defined in Language.LSP.Types.Common

Methods

fold :: Monoid m => List m -> m #

foldMap :: Monoid m => (a -> m) -> List a -> m #

foldMap' :: Monoid m => (a -> m) -> List a -> m #

foldr :: (a -> b -> b) -> b -> List a -> b #

foldr' :: (a -> b -> b) -> b -> List a -> b #

foldl :: (b -> a -> b) -> b -> List a -> b #

foldl' :: (b -> a -> b) -> b -> List a -> b #

foldr1 :: (a -> a -> a) -> List a -> a #

foldl1 :: (a -> a -> a) -> List a -> a #

toList :: List a -> [a] #

null :: List a -> Bool #

length :: List a -> Int #

elem :: Eq a => a -> List a -> Bool #

maximum :: Ord a => List a -> a #

minimum :: Ord a => List a -> a #

sum :: Num a => List a -> a #

product :: Num a => List a -> a #

Traversable List 
Instance details

Defined in Language.LSP.Types.Common

Methods

traverse :: Applicative f => (a -> f b) -> List a -> f (List b) #

sequenceA :: Applicative f => List (f a) -> f (List a) #

mapM :: Monad m => (a -> m b) -> List a -> m (List b) #

sequence :: Monad m => List (m a) -> m (List a) #

HasSignatures SignatureHelp (List SignatureInformation) 
Instance details

Defined in Language.LSP.Types.Lens

HasRetriggerCharacters SignatureHelpRegistrationOptions (Maybe (List Text)) 
Instance details

Defined in Language.LSP.Types.Lens

HasRetriggerCharacters SignatureHelpOptions (Maybe (List Text)) 
Instance details

Defined in Language.LSP.Types.Lens

HasContentFormat HoverClientCapabilities (Maybe (List MarkupKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasRelatedInformation Diagnostic (Maybe (List DiagnosticRelatedInformation)) 
Instance details

Defined in Language.LSP.Types.Lens

HasCommands ExecuteCommandRegistrationOptions (List Text) 
Instance details

Defined in Language.LSP.Types.Lens

HasCommands ExecuteCommandOptions (List Text) 
Instance details

Defined in Language.LSP.Types.Lens

HasArguments Command (Maybe (List Value)) 
Instance details

Defined in Language.LSP.Types.Lens

HasArguments ExecuteCommandParams (Maybe (List Value)) 
Instance details

Defined in Language.LSP.Types.Lens

HasContentChanges DidChangeTextDocumentParams (List TextDocumentContentChangeEvent) 
Instance details

Defined in Language.LSP.Types.Lens

HasAdded WorkspaceFoldersChangeEvent (List WorkspaceFolder) 
Instance details

Defined in Language.LSP.Types.Lens

HasRemoved WorkspaceFoldersChangeEvent (List WorkspaceFolder) 
Instance details

Defined in Language.LSP.Types.Lens

HasResourceOperations WorkspaceEditClientCapabilities (Maybe (List ResourceOperationKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentChanges WorkspaceEdit (Maybe (List DocumentChange)) 
Instance details

Defined in Language.LSP.Types.Lens

HasEdits TextDocumentEdit (List TextEdit) 
Instance details

Defined in Language.LSP.Types.Lens

HasChildren DocumentSymbol (Maybe (List DocumentSymbol)) 
Instance details

Defined in Language.LSP.Types.Lens

HasPositions SelectionRangeParams (List Position) 
Instance details

Defined in Language.LSP.Types.Lens

HasDiagnostics CodeAction (Maybe (List Diagnostic)) 
Instance details

Defined in Language.LSP.Types.Lens

HasDiagnostics CodeActionContext (List Diagnostic) 
Instance details

Defined in Language.LSP.Types.Lens

HasDiagnostics PublishDiagnosticsParams (List Diagnostic) 
Instance details

Defined in Language.LSP.Types.Lens

HasOnly CodeActionContext (Maybe (List CodeActionKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasCodeActionKinds CodeActionRegistrationOptions (Maybe (List CodeActionKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasCodeActionKinds CodeActionOptions (Maybe (List CodeActionKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentationFormat CompletionItemClientCapabilities (Maybe (List MarkupKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentationFormat SignatureHelpSignatureInformation (Maybe (List MarkupKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector CodeActionRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector CompletionRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DocumentColorRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector CodeLensRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DeclarationRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DefinitionRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DocumentHighlightRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DocumentLinkRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DocumentSymbolRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector FoldingRangeRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DocumentOnTypeFormattingRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DocumentRangeFormattingRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector DocumentFormattingRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector HoverRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector ImplementationRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector ReferenceRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector RenameRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector SelectionRangeRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector SignatureHelpRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector TypeDefinitionRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector TextDocumentSaveRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector TextDocumentChangeRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasDocumentSelector TextDocumentRegistrationOptions (Maybe DocumentSelector) 
Instance details

Defined in Language.LSP.Types.Lens

HasTriggerCharacters SignatureHelpRegistrationOptions (Maybe (List Text)) 
Instance details

Defined in Language.LSP.Types.Lens

HasTriggerCharacters SignatureHelpOptions (Maybe (List Text)) 
Instance details

Defined in Language.LSP.Types.Lens

HasAdditionalTextEdits CompletionItem (Maybe (List TextEdit)) 
Instance details

Defined in Language.LSP.Types.Lens

HasAdditionalTextEdits ColorPresentation (Maybe (List TextEdit)) 
Instance details

Defined in Language.LSP.Types.Lens

HasCommitCharacters CompletionItem (Maybe (List Text)) 
Instance details

Defined in Language.LSP.Types.Lens

HasTags CompletionItem (Maybe (List CompletionItemTag)) 
Instance details

Defined in Language.LSP.Types.Lens

HasTags Diagnostic (Maybe (List DiagnosticTag)) 
Instance details

Defined in Language.LSP.Types.Lens

HasValueSet WorkspaceSymbolKindClientCapabilities (Maybe (List SymbolKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasValueSet CodeActionKindClientCapabilities (List CodeActionKind) 
Instance details

Defined in Language.LSP.Types.Lens

HasValueSet CompletionItemKindClientCapabilities (Maybe (List CompletionItemKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasValueSet CompletionItemTagsClientCapabilities (List CompletionItemTag) 
Instance details

Defined in Language.LSP.Types.Lens

HasValueSet PublishDiagnosticsTagsClientCapabilities (List DiagnosticTag) 
Instance details

Defined in Language.LSP.Types.Lens

HasValueSet DocumentSymbolKindClientCapabilities (Maybe (List SymbolKind)) 
Instance details

Defined in Language.LSP.Types.Lens

HasChanges WorkspaceEdit (Maybe WorkspaceEditMap) 
Instance details

Defined in Language.LSP.Types.Lens

HasChanges DidChangeWatchedFilesParams (List FileEvent) 
Instance details

Defined in Language.LSP.Types.Lens

HasWatchers DidChangeWatchedFilesRegistrationOptions (List FileSystemWatcher) 
Instance details

Defined in Language.LSP.Types.Lens

HasItems CompletionList (List CompletionItem) 
Instance details

Defined in Language.LSP.Types.Lens

HasItems ConfigurationParams (List ConfigurationItem) 
Instance details

Defined in Language.LSP.Types.Lens

HasParameters SignatureInformation (Maybe (List ParameterInformation)) 
Instance details

Defined in Language.LSP.Types.Lens

HasUnregisterations UnregistrationParams (List Unregistration) 
Instance details

Defined in Language.LSP.Types.Lens

HasRegistrations RegistrationParams (List SomeRegistration) 
Instance details

Defined in Language.LSP.Types.Lens

HasWorkspaceFolders InitializeParams (Maybe (List WorkspaceFolder)) 
Instance details

Defined in Language.LSP.Types.Lens

Eq a => Eq (List a) 
Instance details

Defined in Language.LSP.Types.Common

Methods

(==) :: List a -> List a -> Bool #

(/=) :: List a -> List a -> Bool #

Ord a => Ord (List a) 
Instance details

Defined in Language.LSP.Types.Common

Methods

compare :: List a -> List a -> Ordering #

(<) :: List a -> List a -> Bool #

(<=) :: List a -> List a -> Bool #

(>) :: List a -> List a -> Bool #

(>=) :: List a -> List a -> Bool #

max :: List a -> List a -> List a #

min :: List a -> List a -> List a #

Read a => Read (List a) 
Instance details

Defined in Language.LSP.Types.Common

Show a => Show (List a) 
Instance details

Defined in Language.LSP.Types.Common

Methods

showsPrec :: Int -> List a -> ShowS #

show :: List a -> String #

showList :: [List a] -> ShowS #

Generic (List a) 
Instance details

Defined in Language.LSP.Types.Common

Associated Types

type Rep (List a) :: Type -> Type #

Methods

from :: List a -> Rep (List a) x #

to :: Rep (List a) x -> List a #

Semigroup (List a) 
Instance details

Defined in Language.LSP.Types.Common

Methods

(<>) :: List a -> List a -> List a #

sconcat :: NonEmpty (List a) -> List a #

stimes :: Integral b => b -> List a -> List a #

Monoid (List a) 
Instance details

Defined in Language.LSP.Types.Common

Methods

mempty :: List a #

mappend :: List a -> List a -> List a #

mconcat :: [List a] -> List a #

ToJSON a => ToJSON (List a) 
Instance details

Defined in Language.LSP.Types.Common

FromJSON a => FromJSON (List a) 
Instance details

Defined in Language.LSP.Types.Common

NFData a => NFData (List a) 
Instance details

Defined in Language.LSP.Types.Common

Methods

rnf :: List a -> () #

type Rep (List a) 
Instance details

Defined in Language.LSP.Types.Common

type Rep (List a) = D1 ('MetaData "List" "Language.LSP.Types.Common" "lsp-types-1.1.0.0-49IPbTxRu66JZc3LjJqiaC" 'True) (C1 ('MetaCons "List" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])))