Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Test.Hls
Synopsis
- module Test.Tasty.HUnit
- withResource :: IO a -> (a -> IO ()) -> (IO a -> TestTree) -> TestTree
- askOption :: IsOption v => (v -> TestTree) -> TestTree
- localOption :: IsOption v => v -> TestTree -> TestTree
- adjustOption :: IsOption v => (v -> v) -> TestTree -> TestTree
- defaultMain :: TestTree -> IO ()
- defaultIngredients :: [Ingredient]
- defaultMainWithIngredients :: [Ingredient] -> TestTree -> IO ()
- includingOptions :: [OptionDescription] -> Ingredient
- after :: DependencyType -> String -> TestTree -> TestTree
- after_ :: DependencyType -> Expr -> TestTree -> TestTree
- testGroup :: TestName -> [TestTree] -> TestTree
- type TestName = String
- data DependencyType
- data TestTree
- mkTimeout :: Integer -> Timeout
- pattern NoTimeout :: Timeout
- module Test.Tasty.ExpectedFailure
- module Test.Hls.Util
- data Int32
- newtype List a = List [a]
- data NormalizedFilePath
- newtype Uri = Uri {}
- toNormalizedUri :: Uri -> NormalizedUri
- fromNormalizedUri :: NormalizedUri -> Uri
- fromNormalizedFilePath :: NormalizedFilePath -> FilePath
- data Location = Location {}
- data DiagnosticSeverity
- data Diagnostic = Diagnostic {}
- data Range = Range {}
- data Position = Position {
- _line :: UInt
- _character :: UInt
- data NormalizedUri = NormalizedUri !Int !Text
- data WorkspaceEdit = WorkspaceEdit {}
- positionInRange :: Position -> Range -> Bool
- data Method (f :: From) (t :: MethodType) where
- Initialize :: Method 'FromClient 'Request
- Initialized :: Method 'FromClient 'Notification
- Shutdown :: Method 'FromClient 'Request
- Exit :: Method 'FromClient 'Notification
- WorkspaceDidChangeWorkspaceFolders :: Method 'FromClient 'Notification
- WorkspaceDidChangeConfiguration :: Method 'FromClient 'Notification
- WorkspaceDidChangeWatchedFiles :: Method 'FromClient 'Notification
- WorkspaceSymbol :: Method 'FromClient 'Request
- WorkspaceExecuteCommand :: Method 'FromClient 'Request
- TextDocumentDidOpen :: Method 'FromClient 'Notification
- TextDocumentDidChange :: Method 'FromClient 'Notification
- TextDocumentWillSave :: Method 'FromClient 'Notification
- TextDocumentWillSaveWaitUntil :: Method 'FromClient 'Request
- TextDocumentDidSave :: Method 'FromClient 'Notification
- TextDocumentDidClose :: Method 'FromClient 'Notification
- TextDocumentCompletion :: Method 'FromClient 'Request
- CompletionItemResolve :: Method 'FromClient 'Request
- TextDocumentHover :: Method 'FromClient 'Request
- TextDocumentSignatureHelp :: Method 'FromClient 'Request
- TextDocumentDeclaration :: Method 'FromClient 'Request
- TextDocumentDefinition :: Method 'FromClient 'Request
- TextDocumentTypeDefinition :: Method 'FromClient 'Request
- TextDocumentImplementation :: Method 'FromClient 'Request
- TextDocumentReferences :: Method 'FromClient 'Request
- TextDocumentDocumentHighlight :: Method 'FromClient 'Request
- TextDocumentDocumentSymbol :: Method 'FromClient 'Request
- TextDocumentCodeAction :: Method 'FromClient 'Request
- TextDocumentCodeLens :: Method 'FromClient 'Request
- CodeLensResolve :: Method 'FromClient 'Request
- TextDocumentDocumentLink :: Method 'FromClient 'Request
- DocumentLinkResolve :: Method 'FromClient 'Request
- TextDocumentDocumentColor :: Method 'FromClient 'Request
- TextDocumentColorPresentation :: Method 'FromClient 'Request
- TextDocumentFormatting :: Method 'FromClient 'Request
- TextDocumentRangeFormatting :: Method 'FromClient 'Request
- TextDocumentOnTypeFormatting :: Method 'FromClient 'Request
- TextDocumentRename :: Method 'FromClient 'Request
- TextDocumentPrepareRename :: Method 'FromClient 'Request
- TextDocumentFoldingRange :: Method 'FromClient 'Request
- TextDocumentSelectionRange :: Method 'FromClient 'Request
- TextDocumentPrepareCallHierarchy :: Method 'FromClient 'Request
- CallHierarchyIncomingCalls :: Method 'FromClient 'Request
- CallHierarchyOutgoingCalls :: Method 'FromClient 'Request
- TextDocumentSemanticTokens :: Method 'FromClient 'Request
- TextDocumentSemanticTokensFull :: Method 'FromClient 'Request
- TextDocumentSemanticTokensFullDelta :: Method 'FromClient 'Request
- TextDocumentSemanticTokensRange :: Method 'FromClient 'Request
- WindowShowMessage :: Method 'FromServer 'Notification
- WindowShowMessageRequest :: Method 'FromServer 'Request
- WindowShowDocument :: Method 'FromServer 'Request
- WindowLogMessage :: Method 'FromServer 'Notification
- WindowWorkDoneProgressCancel :: Method 'FromClient 'Notification
- WindowWorkDoneProgressCreate :: Method 'FromServer 'Request
- Progress :: Method 'FromServer 'Notification
- TelemetryEvent :: Method 'FromServer 'Notification
- ClientRegisterCapability :: Method 'FromServer 'Request
- ClientUnregisterCapability :: Method 'FromServer 'Request
- WorkspaceWorkspaceFolders :: Method 'FromServer 'Request
- WorkspaceConfiguration :: Method 'FromServer 'Request
- WorkspaceApplyEdit :: Method 'FromServer 'Request
- WorkspaceSemanticTokensRefresh :: Method 'FromServer 'Request
- TextDocumentPublishDiagnostics :: Method 'FromServer 'Notification
- CancelRequest :: forall (f :: From). Method f 'Notification
- CustomMethod :: forall (f :: From) (t :: MethodType). Method f t
- mEqClient :: forall {t1 :: MethodType} {t2 :: MethodType} (m1 :: Method 'FromClient t1) (m2 :: Method 'FromClient t2). SClientMethod m1 -> SClientMethod m2 -> Maybe (Either (CustomEq m1 m2) (m1 :~~: m2))
- mEqServer :: forall {t1 :: MethodType} {t2 :: MethodType} (m1 :: Method 'FromServer t1) (m2 :: Method 'FromServer t2). SServerMethod m1 -> SServerMethod m2 -> Maybe (Either (CustomEq m1 m2) (m1 :~~: m2))
- runEq :: forall (t1 :: MethodType) (t2 :: MethodType) (f :: From) (m1 :: Method f t1) (m2 :: Method f t2). t1 ~ t2 => (SMethod m1 -> SMethod m2 -> Maybe (Either (CustomEq m1 m2) (m1 :~~: m2))) -> SMethod m1 -> SMethod m2 -> Maybe (m1 :~~: m2)
- splitServerMethod :: forall {t :: MethodType} (m :: Method 'FromServer t). SServerMethod m -> ServerNotOrReq m
- splitClientMethod :: forall {t :: MethodType} (m :: Method 'FromClient t). SClientMethod m -> ClientNotOrReq m
- serverMethodJSON :: forall {t :: MethodType} (m :: Method 'FromServer t) x. SServerMethod m -> (ToJSON (ServerMessage m) => x) -> x
- clientMethodJSON :: forall {t :: MethodType} (m :: Method 'FromClient t) x. SClientMethod m -> (ToJSON (ClientMessage m) => x) -> x
- serverResponseJSON :: forall (m :: Method 'FromServer 'Request) x. SServerMethod m -> (HasJSON (ResponseMessage m) => x) -> x
- clientResponseJSON :: forall (m :: Method 'FromClient 'Request) x. SClientMethod m -> (HasJSON (ResponseMessage m) => x) -> x
- parseClientMessage :: forall (a :: Method 'FromServer 'Request -> Type). LookupFunc 'FromServer a -> Value -> Parser (FromClientMessage' a)
- parseServerMessage :: forall (a :: Method 'FromClient 'Request -> Type). LookupFunc 'FromClient a -> Value -> Parser (FromServerMessage' a)
- fromClientReq :: forall (m :: Method 'FromClient 'Request). Message m ~ RequestMessage m => RequestMessage m -> FromClientMessage
- fromClientNot :: forall (m :: Method 'FromClient 'Notification). Message m ~ NotificationMessage m => NotificationMessage m -> FromClientMessage
- fromServerReq :: forall (m :: Method 'FromServer 'Request). Message m ~ RequestMessage m => RequestMessage m -> FromServerMessage
- fromServerNot :: forall (m :: Method 'FromServer 'Notification). Message m ~ NotificationMessage m => NotificationMessage m -> FromServerMessage
- data FromServerMessage' (a :: Method 'FromClient 'Request -> Type) where
- FromServerMess :: forall (t :: MethodType) (m :: Method 'FromServer t) (a :: Method 'FromClient 'Request -> Type). SMethod m -> Message m -> FromServerMessage' a
- FromServerRsp :: forall (m :: Method 'FromClient 'Request) (a :: Method 'FromClient 'Request -> Type). a m -> ResponseMessage m -> FromServerMessage' a
- type FromServerMessage = FromServerMessage' (SMethod :: Method 'FromClient 'Request -> Type)
- data FromClientMessage' (a :: Method 'FromServer 'Request -> Type) where
- FromClientMess :: forall (t :: MethodType) (m :: Method 'FromClient t) (a :: Method 'FromServer 'Request -> Type). SMethod m -> Message m -> FromClientMessage' a
- FromClientRsp :: forall (m :: Method 'FromServer 'Request) (a :: Method 'FromServer 'Request -> Type). a m -> ResponseMessage m -> FromClientMessage' a
- type FromClientMessage = FromClientMessage' (SMethod :: Method 'FromServer 'Request -> Type)
- type LookupFunc (f :: From) (a :: Method f 'Request -> Type) = forall (m :: Method f 'Request). LspId m -> Maybe (SMethod m, a m)
- type HasJSON a = (ToJSON a, FromJSON a, Eq a)
- data ClientNotOrReq (m :: Method 'FromClient t) where
- IsClientNot :: forall (m1 :: Method 'FromClient 'Notification). (HasJSON (ClientMessage m1), Message m1 ~ NotificationMessage m1) => ClientNotOrReq m1
- IsClientReq :: forall (m1 :: Method 'FromClient 'Request). (HasJSON (ClientMessage m1), HasJSON (ResponseMessage m1), Message m1 ~ RequestMessage m1) => ClientNotOrReq m1
- IsClientEither :: forall {t :: MethodType}. ClientNotOrReq ('CustomMethod :: Method 'FromClient t)
- data ServerNotOrReq (m :: Method 'FromServer t) where
- IsServerNot :: forall (m1 :: Method 'FromServer 'Notification). (HasJSON (ServerMessage m1), Message m1 ~ NotificationMessage m1) => ServerNotOrReq m1
- IsServerReq :: forall (m1 :: Method 'FromServer 'Request). (HasJSON (ServerMessage m1), HasJSON (ResponseMessage m1), Message m1 ~ RequestMessage m1) => ServerNotOrReq m1
- IsServerEither :: forall {t :: MethodType}. ServerNotOrReq ('CustomMethod :: Method 'FromServer t)
- data CustomEq (m1 :: Method f t1) (m2 :: Method f t2) where
- CustomEq :: forall (f :: From) (t1 :: MethodType) (m1 :: Method f t1) (t2 :: MethodType) (m2 :: Method f t2). (m1 ~ ('CustomMethod :: Method f t1), m2 ~ ('CustomMethod :: Method f t2)) => {..} -> CustomEq m1 m2
- data ResponseMessage (m :: Method f 'Request) = ResponseMessage {
- _jsonrpc :: Text
- _id :: Maybe (LspId m)
- _result :: Either ResponseError (ResponseResult m)
- type family Message (m :: Method f t) where ...
- type ClientMessage (m :: Method 'FromClient t) = Message m
- type ServerMessage (m :: Method 'FromServer t) = Message m
- addNullField :: String -> Value -> Value
- type family MessageParams (m :: Method f t) where ...
- type family ResponseResult (m :: Method f 'Request) where ...
- data NotificationMessage (m :: Method f 'Notification) = NotificationMessage {}
- data RequestMessage (m :: Method f 'Request) = RequestMessage {}
- data CustomMessage (f :: From) (t :: MethodType) where
- ReqMess :: forall (f :: From). RequestMessage ('CustomMethod :: Method f 'Request) -> CustomMessage f 'Request
- NotMess :: forall (f :: From). NotificationMessage ('CustomMethod :: Method f 'Notification) -> CustomMessage f 'Notification
- data ErrorCode
- data ResponseError = ResponseError {}
- data InitializedParams = InitializedParams
- data InitializeResult = InitializeResult {}
- data ServerInfo = ServerInfo {}
- data InitializeError = InitializeError {}
- data InitializeParams = InitializeParams {}
- data Trace
- data ClientInfo = ClientInfo {}
- data UnregistrationParams = UnregistrationParams {}
- data Unregistration = Unregistration {
- _id :: Text
- _method :: SomeClientMethod
- regHelper :: forall {t :: MethodType} (m :: Method 'FromClient t) x. SMethod m -> ((Show (RegistrationOptions m), ToJSON (RegistrationOptions m), FromJSON (RegistrationOptions m)) => x) -> x
- data SomeRegistration = SomeRegistration (Registration m)
- data RegistrationParams = RegistrationParams {}
- type family RegistrationOptions (m :: Method 'FromClient t) where ...
- data Registration (m :: Method 'FromClient t) = Registration {
- _id :: Text
- _method :: SClientMethod m
- _registerOptions :: !(RegistrationOptions m)
- data WorkspaceSymbolParams = WorkspaceSymbolParams {}
- data WorkspaceSymbolRegistrationOptions = WorkspaceSymbolRegistrationOptions {}
- data WorkspaceSymbolOptions = WorkspaceSymbolOptions {}
- data WorkspaceSymbolClientCapabilities = WorkspaceSymbolClientCapabilities {}
- data WorkspaceSymbolTagClientCapabilities = WorkspaceSymbolTagClientCapabilities {}
- data WorkspaceSymbolKindClientCapabilities = WorkspaceSymbolKindClientCapabilities {
- _valueSet :: Maybe (List SymbolKind)
- data DidChangeWorkspaceFoldersParams = DidChangeWorkspaceFoldersParams {}
- data WorkspaceFoldersChangeEvent = WorkspaceFoldersChangeEvent {}
- data WorkspaceFolder = WorkspaceFolder {}
- data CodeAction = CodeAction {
- _title :: Text
- _kind :: Maybe CodeActionKind
- _diagnostics :: Maybe (List Diagnostic)
- _isPreferred :: Maybe Bool
- _disabled :: Maybe Reason
- _edit :: Maybe WorkspaceEdit
- _command :: Maybe Command
- _xdata :: Maybe Value
- newtype Reason = Reason {}
- data CodeActionParams = CodeActionParams {}
- data CodeActionContext = CodeActionContext {}
- data CodeActionRegistrationOptions = CodeActionRegistrationOptions {}
- data CodeActionOptions = CodeActionOptions {}
- data CodeActionClientCapabilities = CodeActionClientCapabilities {}
- data CodeActionResolveClientCapabilities = CodeActionResolveClientCapabilities {
- _properties :: List Text
- data CodeActionLiteralSupport = CodeActionLiteralSupport {}
- specCodeActionKinds :: [CodeActionKind]
- codeActionKindSubsumes :: CodeActionKind -> CodeActionKind -> Bool
- toHierarchicalString :: CodeActionKind -> Text
- fromHierarchicalString :: Text -> CodeActionKind
- data CodeActionKind
- data CodeActionKindClientCapabilities = CodeActionKindClientCapabilities {}
- data CompletionParams = CompletionParams {}
- data CompletionContext = CompletionContext {}
- data CompletionRegistrationOptions = CompletionRegistrationOptions {}
- data CompletionOptions = CompletionOptions {}
- data CompletionTriggerKind
- data CompletionList = CompletionList {}
- data CompletionItem = CompletionItem {
- _label :: Text
- _kind :: Maybe CompletionItemKind
- _tags :: Maybe (List CompletionItemTag)
- _detail :: Maybe Text
- _documentation :: Maybe CompletionDoc
- _deprecated :: Maybe Bool
- _preselect :: Maybe Bool
- _sortText :: Maybe Text
- _filterText :: Maybe Text
- _insertText :: Maybe Text
- _insertTextFormat :: Maybe InsertTextFormat
- _insertTextMode :: Maybe InsertTextMode
- _textEdit :: Maybe CompletionEdit
- _additionalTextEdits :: Maybe (List TextEdit)
- _commitCharacters :: Maybe (List Text)
- _command :: Maybe Command
- _xdata :: Maybe Value
- data CompletionEdit
- data InsertReplaceEdit = InsertReplaceEdit {}
- data InsertTextFormat
- data CompletionDoc
- data CompletionClientCapabilities = CompletionClientCapabilities {}
- data CompletionItemKindClientCapabilities = CompletionItemKindClientCapabilities {}
- data CompletionItemClientCapabilities = CompletionItemClientCapabilities {
- _snippetSupport :: Maybe Bool
- _commitCharactersSupport :: Maybe Bool
- _documentationFormat :: Maybe (List MarkupKind)
- _deprecatedSupport :: Maybe Bool
- _preselectSupport :: Maybe Bool
- _tagSupport :: Maybe CompletionItemTagsClientCapabilities
- _insertReplaceSupport :: Maybe Bool
- _resolveSupport :: Maybe CompletionItemResolveClientCapabilities
- _insertTextModeSupport :: Maybe CompletionItemInsertTextModeClientCapabilities
- data InsertTextMode
- data CompletionItemInsertTextModeClientCapabilities = CompletionItemInsertTextModeClientCapabilities {}
- data CompletionItemResolveClientCapabilities = CompletionItemResolveClientCapabilities {
- _properties :: List Text
- data CompletionItemKind
- data CompletionItemTag
- data CompletionItemTagsClientCapabilities = CompletionItemTagsClientCapabilities {}
- data ColorPresentation = ColorPresentation {}
- data ColorPresentationParams = ColorPresentationParams {}
- data ColorInformation = ColorInformation {}
- data Color = Color {}
- data DocumentColorParams = DocumentColorParams {}
- data DocumentColorRegistrationOptions = DocumentColorRegistrationOptions {}
- data DocumentColorOptions = DocumentColorOptions {}
- data DocumentColorClientCapabilities = DocumentColorClientCapabilities {}
- editTextEdit :: TextEdit -> TextEdit -> TextEdit
- applyTextEdit :: TextEdit -> Text -> Text
- data ApplyWorkspaceEditResponseBody = ApplyWorkspaceEditResponseBody {}
- data ApplyWorkspaceEditParams = ApplyWorkspaceEditParams {
- _label :: Maybe Text
- _edit :: WorkspaceEdit
- data WorkspaceEditClientCapabilities = WorkspaceEditClientCapabilities {}
- data ResourceOperationKind
- data FailureHandlingKind
- data WorkspaceEditChangeAnnotationClientCapabilities = WorkspaceEditChangeAnnotationClientCapabilities {}
- data DeleteFile = DeleteFile {}
- type DocumentChange = TextDocumentEdit |? (CreateFile |? (RenameFile |? DeleteFile))
- type WorkspaceEditMap = HashMap Uri (List TextEdit)
- type ChangeAnnotationMap = HashMap ChangeAnnotationIdentifier ChangeAnnotation
- data RenameFile = RenameFile {}
- data DeleteFileOptions = DeleteFileOptions {}
- data CreateFile = CreateFile {}
- data RenameFileOptions = RenameFileOptions {}
- data CreateFileOptions = CreateFileOptions {}
- data TextDocumentEdit = TextDocumentEdit {}
- data AnnotatedTextEdit = AnnotatedTextEdit {}
- newtype ChangeAnnotationIdentifier = ChangeAnnotationIdentifierId Text
- data ChangeAnnotation = ChangeAnnotation {}
- data TextEdit = TextEdit {}
- data LogMessageParams = LogMessageParams {
- _xtype :: MessageType
- _message :: Text
- data ShowDocumentResult = ShowDocumentResult {}
- data ShowDocumentParams = ShowDocumentParams {}
- data ShowMessageRequestParams = ShowMessageRequestParams {
- _xtype :: MessageType
- _message :: Text
- _actions :: Maybe [MessageActionItem]
- data MessageActionItem = MessageActionItem {}
- data MessageType
- data ShowMessageParams = ShowMessageParams {
- _xtype :: MessageType
- _message :: Text
- data DidChangeWatchedFilesParams = DidChangeWatchedFilesParams {}
- data FileChangeType
- data FileEvent = FileEvent {
- _uri :: Uri
- _xtype :: FileChangeType
- data DidChangeWatchedFilesRegistrationOptions = DidChangeWatchedFilesRegistrationOptions {}
- data FileSystemWatcher = FileSystemWatcher {
- _globPattern :: Text
- _kind :: Maybe WatchKind
- data WatchKind = WatchKind {
- _watchCreate :: Bool
- _watchChange :: Bool
- _watchDelete :: Bool
- data DidChangeWatchedFilesClientCapabilities = DidChangeWatchedFilesClientCapabilities {}
- data CallHierarchyOutgoingCall = CallHierarchyOutgoingCall {}
- data CallHierarchyOutgoingCallsParams = CallHierarchyOutgoingCallsParams {}
- data CallHierarchyIncomingCall = CallHierarchyIncomingCall {}
- data CallHierarchyIncomingCallsParams = CallHierarchyIncomingCallsParams {}
- data CallHierarchyItem = CallHierarchyItem {}
- data CallHierarchyPrepareParams = CallHierarchyPrepareParams {}
- data CallHierarchyRegistrationOptions = CallHierarchyRegistrationOptions {}
- data CallHierarchyOptions = CallHierarchyOptions {}
- data CallHierarchyClientCapabilities = CallHierarchyClientCapabilities {}
- data CancelParams = CancelParams {}
- data CodeLens = CodeLens {}
- data CodeLensParams = CodeLensParams {}
- data CodeLensRegistrationOptions = CodeLensRegistrationOptions {}
- data CodeLensOptions = CodeLensOptions {}
- data CodeLensClientCapabilities = CodeLensClientCapabilities {}
- data Command = Command {}
- data ExecuteCommandParams = ExecuteCommandParams {
- _workDoneToken :: Maybe ProgressToken
- _command :: Text
- _arguments :: Maybe (List Value)
- data ExecuteCommandRegistrationOptions = ExecuteCommandRegistrationOptions {}
- data ExecuteCommandOptions = ExecuteCommandOptions {}
- data ExecuteCommandClientCapabilities = ExecuteCommandClientCapabilities {}
- data ConfigurationParams = ConfigurationParams {}
- data ConfigurationItem = ConfigurationItem {}
- data DidChangeConfigurationParams = DidChangeConfigurationParams {}
- data DidChangeConfigurationClientCapabilities = DidChangeConfigurationClientCapabilities {}
- data DeclarationParams = DeclarationParams {}
- data DeclarationRegistrationOptions = DeclarationRegistrationOptions {}
- data DeclarationOptions = DeclarationOptions {}
- data DeclarationClientCapabilities = DeclarationClientCapabilities {}
- data DefinitionParams = DefinitionParams {}
- data DefinitionRegistrationOptions = DefinitionRegistrationOptions {}
- data DefinitionOptions = DefinitionOptions {}
- data DefinitionClientCapabilities = DefinitionClientCapabilities {}
- data PublishDiagnosticsParams = PublishDiagnosticsParams {
- _uri :: Uri
- _version :: Maybe UInt
- _diagnostics :: List Diagnostic
- data PublishDiagnosticsClientCapabilities = PublishDiagnosticsClientCapabilities {}
- data PublishDiagnosticsTagsClientCapabilities = PublishDiagnosticsTagsClientCapabilities {}
- type DiagnosticSource = Text
- data DiagnosticTag
- data DiagnosticRelatedInformation = DiagnosticRelatedInformation {}
- data DocumentHighlightKind
- data DocumentHighlight = DocumentHighlight {}
- data DocumentHighlightParams = DocumentHighlightParams {}
- data DocumentHighlightRegistrationOptions = DocumentHighlightRegistrationOptions {}
- data DocumentHighlightOptions = DocumentHighlightOptions {}
- data DocumentHighlightClientCapabilities = DocumentHighlightClientCapabilities {}
- data DocumentLink = DocumentLink {}
- data DocumentLinkParams = DocumentLinkParams {}
- data DocumentLinkRegistrationOptions = DocumentLinkRegistrationOptions {}
- data DocumentLinkOptions = DocumentLinkOptions {}
- data DocumentLinkClientCapabilities = DocumentLinkClientCapabilities {}
- data SymbolInformation = SymbolInformation {}
- data DocumentSymbol = DocumentSymbol {}
- data DocumentSymbolClientCapabilities = DocumentSymbolClientCapabilities {}
- data DocumentSymbolTagClientCapabilities = DocumentSymbolTagClientCapabilities {}
- data SymbolKind
- = SkFile
- | SkModule
- | SkNamespace
- | SkPackage
- | SkClass
- | SkMethod
- | SkProperty
- | SkField
- | SkConstructor
- | SkEnum
- | SkInterface
- | SkFunction
- | SkVariable
- | SkConstant
- | SkString
- | SkNumber
- | SkBoolean
- | SkArray
- | SkObject
- | SkKey
- | SkNull
- | SkEnumMember
- | SkStruct
- | SkEvent
- | SkOperator
- | SkTypeParameter
- | SkUnknown Scientific
- data SymbolTag
- data DocumentSymbolKindClientCapabilities = DocumentSymbolKindClientCapabilities {
- _valueSet :: Maybe (List SymbolKind)
- data DocumentSymbolParams = DocumentSymbolParams {}
- data DocumentSymbolRegistrationOptions = DocumentSymbolRegistrationOptions {}
- data DocumentSymbolOptions = DocumentSymbolOptions {}
- data FoldingRangeKind
- data FoldingRange = FoldingRange {}
- data FoldingRangeParams = FoldingRangeParams {}
- data FoldingRangeRegistrationOptions = FoldingRangeRegistrationOptions {}
- data FoldingRangeOptions = FoldingRangeOptions {}
- data FoldingRangeClientCapabilities = FoldingRangeClientCapabilities {}
- data DocumentOnTypeFormattingParams = DocumentOnTypeFormattingParams {}
- data DocumentOnTypeFormattingRegistrationOptions = DocumentOnTypeFormattingRegistrationOptions {}
- data DocumentOnTypeFormattingOptions = DocumentOnTypeFormattingOptions {}
- data DocumentOnTypeFormattingClientCapabilities = DocumentOnTypeFormattingClientCapabilities {}
- data DocumentRangeFormattingParams = DocumentRangeFormattingParams {}
- data DocumentRangeFormattingRegistrationOptions = DocumentRangeFormattingRegistrationOptions {}
- data DocumentRangeFormattingOptions = DocumentRangeFormattingOptions {}
- data DocumentRangeFormattingClientCapabilities = DocumentRangeFormattingClientCapabilities {}
- data DocumentFormattingParams = DocumentFormattingParams {}
- data FormattingOptions = FormattingOptions {}
- data DocumentFormattingRegistrationOptions = DocumentFormattingRegistrationOptions {}
- data DocumentFormattingOptions = DocumentFormattingOptions {}
- data DocumentFormattingClientCapabilities = DocumentFormattingClientCapabilities {}
- toMarkupContent :: MarkedString -> MarkupContent
- data Hover = Hover {}
- data HoverContents
- data MarkedString
- data LanguageString = LanguageString {}
- data HoverParams = HoverParams {}
- data HoverRegistrationOptions = HoverRegistrationOptions {}
- data HoverOptions = HoverOptions {}
- data HoverClientCapabilities = HoverClientCapabilities {}
- data ImplementationParams = ImplementationParams {}
- data ImplementationRegistrationOptions = ImplementationRegistrationOptions {}
- data ImplementationOptions = ImplementationOptions {}
- data ImplementationClientCapabilities = ImplementationClientCapabilities {}
- data ReferenceParams = ReferenceParams {}
- data ReferenceContext = ReferenceContext {}
- data ReferenceRegistrationOptions = ReferenceRegistrationOptions {}
- data ReferenceOptions = ReferenceOptions {}
- data ReferencesClientCapabilities = ReferencesClientCapabilities {}
- data RangeWithPlaceholder = RangeWithPlaceholder {
- _range :: Range
- _placeholder :: Text
- data PrepareRenameParams = PrepareRenameParams {}
- data RenameParams = RenameParams {}
- data RenameRegistrationOptions = RenameRegistrationOptions {}
- data RenameOptions = RenameOptions {}
- data PrepareSupportDefaultBehavior
- data RenameClientCapabilities = RenameClientCapabilities {}
- data SelectionRange = SelectionRange {}
- data SelectionRangeParams = SelectionRangeParams {}
- data SelectionRangeRegistrationOptions = SelectionRangeRegistrationOptions {}
- data SelectionRangeOptions = SelectionRangeOptions {}
- data SelectionRangeClientCapabilities = SelectionRangeClientCapabilities {}
- makeSemanticTokensDelta :: SemanticTokens -> SemanticTokens -> SemanticTokensDelta
- makeSemanticTokens :: SemanticTokensLegend -> [SemanticTokenAbsolute] -> Either Text SemanticTokens
- computeEdits :: Eq a => [a] -> [a] -> [Edit a]
- encodeTokens :: SemanticTokensLegend -> [SemanticTokenRelative] -> Either Text [UInt]
- absolutizeTokens :: [SemanticTokenRelative] -> [SemanticTokenAbsolute]
- relativizeTokens :: [SemanticTokenAbsolute] -> [SemanticTokenRelative]
- $sel:tokenType:SemanticTokenAbsolute :: SemanticTokenAbsolute -> SemanticTokenTypes
- $sel:startChar:SemanticTokenAbsolute :: SemanticTokenAbsolute -> UInt
- pattern SemanticTokenAbsolute :: UInt -> UInt -> UInt -> SemanticTokenTypes -> [SemanticTokenModifiers] -> SemanticTokenAbsolute
- $sel:tokenModifiers:SemanticTokenAbsolute :: SemanticTokenAbsolute -> [SemanticTokenModifiers]
- $sel:deltaStartChar:SemanticTokenRelative :: SemanticTokenRelative -> UInt
- $sel:tokenType:SemanticTokenRelative :: SemanticTokenRelative -> SemanticTokenTypes
- $sel:tokenModifiers:SemanticTokenRelative :: SemanticTokenRelative -> [SemanticTokenModifiers]
- pattern SemanticTokenRelative :: UInt -> UInt -> UInt -> SemanticTokenTypes -> [SemanticTokenModifiers] -> SemanticTokenRelative
- $sel:deltaLine:SemanticTokenRelative :: SemanticTokenRelative -> UInt
- data Edit a = Edit {
- editStart :: UInt
- editDeleteCount :: UInt
- editInsertions :: [a]
- data SemanticTokensWorkspaceClientCapabilities = SemanticTokensWorkspaceClientCapabilities {}
- data SemanticTokensRangeParams = SemanticTokensRangeParams {}
- data SemanticTokensDeltaPartialResult = SemantictokensDeltaPartialResult {}
- data SemanticTokensDelta = SemanticTokensDelta {}
- $sel:_deleteCount:SemanticTokensEdit :: SemanticTokensEdit -> UInt
- pattern SemanticTokensEdit :: UInt -> UInt -> Maybe (List UInt) -> SemanticTokensEdit
- $sel:_xdata:SemanticTokensEdit :: SemanticTokensEdit -> Maybe (List UInt)
- data SemanticTokensDeltaParams = SemanticTokensDeltaParams {}
- data SemanticTokensPartialResult = SemanticTokensPartialResult {}
- data SemanticTokens = SemanticTokens {}
- data SemanticTokensParams = SemanticTokensParams {}
- data SemanticTokensRegistrationOptions = SemanticTokensRegistrationOptions {}
- data SemanticTokensOptions = SemanticTokensOptions {}
- data SemanticTokensClientCapabilities = SemanticTokensClientCapabilities {}
- data SemanticTokensRequestsClientCapabilities = SemanticTokensRequestsClientCapabilities {}
- data SemanticTokensFullClientCapabilities
- data SemanticTokensDeltaClientCapabilities = SemanticTokensDeltaClientCapabilities {}
- data SemanticTokensRangeClientCapabilities
- knownSemanticTokenModifiers :: [SemanticTokenModifiers]
- knownSemanticTokenTypes :: [SemanticTokenTypes]
- data SemanticTokenTypes
- data SemanticTokenModifiers
- data TokenFormat = TokenFormatRelative
- data SemanticTokensLegend = SemanticTokensLegend {}
- data SignatureHelpParams = SignatureHelpParams {}
- data SignatureHelpTriggerKind
- data SignatureHelpContext = SignatureHelpContext {}
- data SignatureHelp = SignatureHelp {}
- data SignatureInformation = SignatureInformation {}
- data ParameterLabel
- data ParameterInformation = ParameterInformation {}
- data SignatureHelpDoc
- data SignatureHelpRegistrationOptions = SignatureHelpRegistrationOptions {}
- data SignatureHelpOptions = SignatureHelpOptions {}
- data SignatureHelpClientCapabilities = SignatureHelpClientCapabilities {}
- data SignatureHelpSignatureInformation = SignatureHelpSignatureInformation {}
- data SignatureHelpParameterInformation = SignatureHelpParameterInformation {}
- data TypeDefinitionParams = TypeDefinitionParams {}
- data TypeDefinitionRegistrationOptions = TypeDefinitionRegistrationOptions {}
- data TypeDefinitionOptions = TypeDefinitionOptions {}
- data TypeDefinitionClientCapabilities = TypeDefinitionClientCapabilities {}
- data DidCloseTextDocumentParams = DidCloseTextDocumentParams {}
- data DidSaveTextDocumentParams = DidSaveTextDocumentParams {}
- data TextDocumentSaveRegistrationOptions = TextDocumentSaveRegistrationOptions {}
- data TextDocumentSaveReason
- data WillSaveTextDocumentParams = WillSaveTextDocumentParams {}
- data DidChangeTextDocumentParams = DidChangeTextDocumentParams {}
- data TextDocumentContentChangeEvent = TextDocumentContentChangeEvent {}
- data TextDocumentChangeRegistrationOptions = TextDocumentChangeRegistrationOptions {}
- data DidOpenTextDocumentParams = DidOpenTextDocumentParams {}
- data TextDocumentRegistrationOptions = TextDocumentRegistrationOptions {}
- data TextDocumentSyncKind
- data TextDocumentSyncOptions = TextDocumentSyncOptions {}
- data SaveOptions = SaveOptions {}
- data TextDocumentSyncClientCapabilities = TextDocumentSyncClientCapabilities {}
- data TextDocumentPositionParams = TextDocumentPositionParams {}
- data TextDocumentItem = TextDocumentItem {}
- data VersionedTextDocumentIdentifier = VersionedTextDocumentIdentifier {}
- type TextDocumentVersion = Maybe Int32
- data TextDocumentIdentifier = TextDocumentIdentifier {}
- type DocumentSelector = List DocumentFilter
- data DocumentFilter = DocumentFilter {}
- isSubrangeOf :: Range -> Range -> Bool
- mkRange :: UInt -> UInt -> UInt -> UInt -> Range
- data LocationLink = LocationLink {}
- plainTextToMarkdown :: Text -> Text
- sectionSeparator :: Text
- unmarkedUpContent :: Text -> MarkupContent
- markedUpContent :: Text -> Text -> MarkupContent
- data MarkdownClientCapabilities = MarkdownClientCapabilities {}
- data MarkupKind
- data MarkupContent = MarkupContent {
- _kind :: MarkupKind
- _value :: Text
- data LspId (m :: Method f 'Request)
- data SomeLspId where
- data From
- data MethodType
- data SMethod (m :: Method f t) where
- SInitialize :: SMethod 'Initialize
- SInitialized :: SMethod 'Initialized
- SShutdown :: SMethod 'Shutdown
- SExit :: SMethod 'Exit
- SWorkspaceDidChangeWorkspaceFolders :: SMethod 'WorkspaceDidChangeWorkspaceFolders
- SWorkspaceDidChangeConfiguration :: SMethod 'WorkspaceDidChangeConfiguration
- SWorkspaceDidChangeWatchedFiles :: SMethod 'WorkspaceDidChangeWatchedFiles
- SWorkspaceSymbol :: SMethod 'WorkspaceSymbol
- SWorkspaceExecuteCommand :: SMethod 'WorkspaceExecuteCommand
- STextDocumentDidOpen :: SMethod 'TextDocumentDidOpen
- STextDocumentDidChange :: SMethod 'TextDocumentDidChange
- STextDocumentWillSave :: SMethod 'TextDocumentWillSave
- STextDocumentWillSaveWaitUntil :: SMethod 'TextDocumentWillSaveWaitUntil
- STextDocumentDidSave :: SMethod 'TextDocumentDidSave
- STextDocumentDidClose :: SMethod 'TextDocumentDidClose
- STextDocumentCompletion :: SMethod 'TextDocumentCompletion
- SCompletionItemResolve :: SMethod 'CompletionItemResolve
- STextDocumentHover :: SMethod 'TextDocumentHover
- STextDocumentSignatureHelp :: SMethod 'TextDocumentSignatureHelp
- STextDocumentDeclaration :: SMethod 'TextDocumentDeclaration
- STextDocumentDefinition :: SMethod 'TextDocumentDefinition
- STextDocumentTypeDefinition :: SMethod 'TextDocumentTypeDefinition
- STextDocumentImplementation :: SMethod 'TextDocumentImplementation
- STextDocumentReferences :: SMethod 'TextDocumentReferences
- STextDocumentDocumentHighlight :: SMethod 'TextDocumentDocumentHighlight
- STextDocumentDocumentSymbol :: SMethod 'TextDocumentDocumentSymbol
- STextDocumentCodeAction :: SMethod 'TextDocumentCodeAction
- STextDocumentCodeLens :: SMethod 'TextDocumentCodeLens
- SCodeLensResolve :: SMethod 'CodeLensResolve
- STextDocumentDocumentLink :: SMethod 'TextDocumentDocumentLink
- SDocumentLinkResolve :: SMethod 'DocumentLinkResolve
- STextDocumentDocumentColor :: SMethod 'TextDocumentDocumentColor
- STextDocumentColorPresentation :: SMethod 'TextDocumentColorPresentation
- STextDocumentFormatting :: SMethod 'TextDocumentFormatting
- STextDocumentRangeFormatting :: SMethod 'TextDocumentRangeFormatting
- STextDocumentOnTypeFormatting :: SMethod 'TextDocumentOnTypeFormatting
- STextDocumentRename :: SMethod 'TextDocumentRename
- STextDocumentPrepareRename :: SMethod 'TextDocumentPrepareRename
- STextDocumentFoldingRange :: SMethod 'TextDocumentFoldingRange
- STextDocumentSelectionRange :: SMethod 'TextDocumentSelectionRange
- STextDocumentPrepareCallHierarchy :: SMethod 'TextDocumentPrepareCallHierarchy
- SCallHierarchyIncomingCalls :: SMethod 'CallHierarchyIncomingCalls
- SCallHierarchyOutgoingCalls :: SMethod 'CallHierarchyOutgoingCalls
- STextDocumentSemanticTokens :: SMethod 'TextDocumentSemanticTokens
- STextDocumentSemanticTokensFull :: SMethod 'TextDocumentSemanticTokensFull
- STextDocumentSemanticTokensFullDelta :: SMethod 'TextDocumentSemanticTokensFullDelta
- STextDocumentSemanticTokensRange :: SMethod 'TextDocumentSemanticTokensRange
- SWorkspaceSemanticTokensRefresh :: SMethod 'WorkspaceSemanticTokensRefresh
- SWindowShowMessage :: SMethod 'WindowShowMessage
- SWindowShowMessageRequest :: SMethod 'WindowShowMessageRequest
- SWindowShowDocument :: SMethod 'WindowShowDocument
- SWindowLogMessage :: SMethod 'WindowLogMessage
- SWindowWorkDoneProgressCreate :: SMethod 'WindowWorkDoneProgressCreate
- SWindowWorkDoneProgressCancel :: SMethod 'WindowWorkDoneProgressCancel
- SProgress :: SMethod 'Progress
- STelemetryEvent :: SMethod 'TelemetryEvent
- SClientRegisterCapability :: SMethod 'ClientRegisterCapability
- SClientUnregisterCapability :: SMethod 'ClientUnregisterCapability
- SWorkspaceWorkspaceFolders :: SMethod 'WorkspaceWorkspaceFolders
- SWorkspaceConfiguration :: SMethod 'WorkspaceConfiguration
- SWorkspaceApplyEdit :: SMethod 'WorkspaceApplyEdit
- STextDocumentPublishDiagnostics :: SMethod 'TextDocumentPublishDiagnostics
- SCancelRequest :: forall {f :: From}. SMethod ('CancelRequest :: Method f 'Notification)
- SCustomMethod :: forall {f :: From} {t :: MethodType}. Text -> SMethod ('CustomMethod :: Method f t)
- type SClientMethod (m :: Method 'FromClient t) = SMethod m
- type SServerMethod (m :: Method 'FromServer t) = SMethod m
- data SomeClientMethod = SomeClientMethod (SMethod m)
- data SomeServerMethod = SomeServerMethod (SMethod m)
- data SomeMethod where
- SomeMethod :: forall {f :: From} {t :: MethodType} (m :: Method f t). SMethod m -> SomeMethod
- data PartialResultParams = PartialResultParams {}
- data SomeProgressParams
- data WorkDoneProgressParams = WorkDoneProgressParams {}
- data WorkDoneProgressOptions = WorkDoneProgressOptions {}
- data WorkDoneProgressCreateParams = WorkDoneProgressCreateParams {}
- data WorkDoneProgressBeginParams = WorkDoneProgressBeginParams {}
- data WorkDoneProgressReportParams = WorkDoneProgressReportParams {
- _cancellable :: Maybe Bool
- _message :: Maybe Text
- _percentage :: Maybe UInt
- data WorkDoneProgressEndParams = WorkDoneProgressEndParams {}
- data WorkDoneProgressCancelParams = WorkDoneProgressCancelParams {}
- data ProgressParams t = ProgressParams {
- _token :: ProgressToken
- _value :: t
- data ProgressToken
- data StaticRegistrationOptions = StaticRegistrationOptions {}
- emptyNormalizedFilePath :: NormalizedFilePath
- uriToNormalizedFilePath :: NormalizedUri -> Maybe NormalizedFilePath
- normalizedFilePathToUri :: NormalizedFilePath -> NormalizedUri
- toNormalizedFilePath :: FilePath -> NormalizedFilePath
- platformAwareFilePathToUri :: SystemOS -> FilePath -> Uri
- filePathToUri :: FilePath -> Uri
- platformAwareUriToFilePath :: String -> Uri -> Maybe FilePath
- uriToFilePath :: Uri -> Maybe FilePath
- toEither :: (a |? b) -> Either a b
- data UInt
- data a |? b
- data Empty = Empty
- module Language.LSP.Test
- module Control.Monad.IO.Class
- module Control.Applicative.Combinators
- defaultTestRunner :: TestTree -> IO ()
- goldenGitDiff :: TestName -> FilePath -> IO ByteString -> TestTree
- goldenWithHaskellDoc :: PluginDescriptor IdeState -> TestName -> FilePath -> FilePath -> FilePath -> FilePath -> (TextDocumentIdentifier -> Session ()) -> TestTree
- goldenWithHaskellDocFormatter :: PluginDescriptor IdeState -> String -> PluginConfig -> TestName -> FilePath -> FilePath -> FilePath -> FilePath -> (TextDocumentIdentifier -> Session ()) -> TestTree
- def :: Default a => a
- runSessionWithServer :: PluginDescriptor IdeState -> FilePath -> Session a -> IO a
- runSessionWithServerFormatter :: PluginDescriptor IdeState -> String -> PluginConfig -> FilePath -> Session a -> IO a
- runSessionWithServer' :: [PluginDescriptor IdeState] -> Config -> SessionConfig -> ClientCapabilities -> FilePath -> Session a -> IO a
- waitForProgressDone :: Session ()
- waitForAllProgressDone :: Session ()
- data PluginDescriptor ideState
- data IdeState
- waitForBuildQueue :: Session Seconds
- waitForTypecheck :: TextDocumentIdentifier -> Session (Either ResponseError Bool)
- waitForAction :: String -> TextDocumentIdentifier -> Session (Either ResponseError WaitForIdeRuleResult)
- sendConfigurationChanged :: Value -> Session ()
- getLastBuildKeys :: Session (Either ResponseError [Text])
- waitForKickDone :: Session ()
- waitForKickStart :: Session ()
Documentation
module Test.Tasty.HUnit
Arguments
:: IO a | initialize the resource |
-> (a -> IO ()) | free the resource |
-> (IO a -> TestTree) |
|
-> TestTree |
Acquire the resource to run this test (sub)tree and release it afterwards
askOption :: IsOption v => (v -> TestTree) -> TestTree #
Customize the test tree based on the run-time options
localOption :: IsOption v => v -> TestTree -> TestTree #
Locally set the option value for the given test subtree
adjustOption :: IsOption v => (v -> v) -> TestTree -> TestTree #
Locally adjust the option value for the given test subtree
defaultMain :: TestTree -> IO () #
Parse the command line arguments and run the tests.
When the tests finish, this function calls exitWith
with the exit code
that indicates whether any tests have failed. Most external systems
(stack, cabal, travis-ci, jenkins etc.) rely on the exit code to detect
whether the tests pass. If you want to do something else after
defaultMain
returns, you need to catch the exception and then re-throw
it. Example:
import Test.Tasty import Test.Tasty.HUnit import System.Exit import Control.Exception test = testCase "Test 1" (2 @?= 3) main = defaultMain test `catch` (\e -> do if e == ExitSuccess then putStrLn "Yea" else putStrLn "Nay" throwIO e)
defaultIngredients :: [Ingredient] #
List of the default ingredients. This is what defaultMain
uses.
At the moment it consists of listingTests
and consoleTestReporter
.
defaultMainWithIngredients :: [Ingredient] -> TestTree -> IO () #
Parse the command line arguments and run the tests using the provided ingredient list.
When the tests finish, this function calls exitWith
with the exit code
that indicates whether any tests have failed. See defaultMain
for
details.
includingOptions :: [OptionDescription] -> Ingredient #
This ingredient doesn't do anything apart from registering additional options.
The option values can be accessed using askOption
.
Arguments
:: DependencyType | whether to run the tests even if some of the dependencies fail |
-> String | the pattern |
-> TestTree | the subtree that depends on other tests |
-> TestTree | the subtree annotated with dependency information |
The after
combinator declares dependencies between tests.
If a TestTree
is wrapped in after
, the tests in this tree will not run
until certain other tests («dependencies») have finished. These
dependencies are specified using an AWK pattern (see the «Patterns» section
in the README).
Moreover, if the DependencyType
argument is set to AllSucceed
and
at least one dependency has failed, this test tree will not run at all.
Tasty does not check that the pattern matches any tests (let alone the correct set of tests), so it is on you to supply the right pattern.
Examples
The following test will be executed only after all tests that contain
Foo
anywhere in their path finish.
after
AllFinish
"Foo" $testCase
"A test that depends on Foo.Bar" $ ...
Note, however, that our test also happens to contain Foo
as part of its name,
so it also matches the pattern and becomes a dependency of itself. This
will result in a DependencyLoop
exception. To avoid this, either
change the test name so that it doesn't mention Foo
or make the
pattern more specific.
You can use AWK patterns, for instance, to specify the full path to the dependency.
after
AllFinish
"$0 == \"Tests.Foo.Bar\"" $testCase
"A test that depends on Foo.Bar" $ ...
Or only specify the dependency's own name, ignoring the group names:
after
AllFinish
"$NF == \"Bar\"" $testCase
"A test that depends on Foo.Bar" $ ...
Since: tasty-1.2
Arguments
:: DependencyType | whether to run the tests even if some of the dependencies fail |
-> Expr | the pattern |
-> TestTree | the subtree that depends on other tests |
-> TestTree | the subtree annotated with dependency information |
Like after
, but accepts the pattern as a syntax tree instead
of a string. Useful for generating a test tree programmatically.
Examples
Only match on the test's own name, ignoring the group names:
after_
AllFinish
(EQ
(Field
NF
) (StringLit
"Bar")) $testCase
"A test that depends on Foo.Bar" $ ...
Since: tasty-1.2
data DependencyType #
These are the two ways in which one test may depend on the others.
This is the same distinction as the hard vs soft dependencies in TestNG.
Since: tasty-1.2
Constructors
AllSucceed | The current test tree will be executed after its dependencies finish, and only if all of the dependencies succeed. |
AllFinish | The current test tree will be executed after its dependencies finish, regardless of whether they succeed or not. |
Instances
Show DependencyType | |
Defined in Test.Tasty.Core Methods showsPrec :: Int -> DependencyType -> ShowS # show :: DependencyType -> String # showList :: [DependencyType] -> ShowS # | |
Eq DependencyType | |
Defined in Test.Tasty.Core Methods (==) :: DependencyType -> DependencyType -> Bool # (/=) :: DependencyType -> DependencyType -> Bool # |
The main data structure defining a test suite.
It consists of individual test cases and properties, organized in named groups which form a tree-like hierarchy.
There is no generic way to create a test case. Instead, every test
provider (tasty-hunit, tasty-smallcheck etc.) provides a function to
turn a test case into a TestTree
.
Groups can be created using testGroup
.
module Test.Tasty.ExpectedFailure
module Test.Hls.Util
32-bit signed integer type
Instances
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
data NormalizedFilePath #
A file path that is already normalized.
The NormalizedUri
is cached to avoided
repeated normalisation when we need to compute them (which is a lot).
This is one of the most performance critical parts of HLS, do not modify it without profiling.
Adoption Plan of OsPath
Currently we store Text
. We may change it to OsPath in the future if
the following steps are executed.
- In the client codebase, use
osPathToNormalizedFilePath
andnormalizedFilePathToOsPath
instead offromNormalizedFilePath
andtoNormalizedFilePath
. For HLS, we could wait until GHC 9.6 becomes the oldest GHC we support, then changeFilePath
to OsPath everywhere in the codebase. - Deprecate and remove
fromNormalizedFilePath
andtoNormalizedFilePath
. - Change
Text
to OsPath and benchmark it to make sure performance doesn't go down. Don't forget to check Windows, as OsPath on Windows uses UTF-16, which may consume more memory.
Instances
Instances
toNormalizedUri :: Uri -> NormalizedUri #
fromNormalizedUri :: NormalizedUri -> Uri #
fromNormalizedFilePath :: NormalizedFilePath -> FilePath #
Extracts FilePath
from NormalizedFilePath
.
Instances
FromJSON Location | |
ToJSON Location | |
Defined in Language.LSP.Types.Location | |
Generic Location | |
Read Location | |
Show Location | |
NFData Location | |
Defined in Language.LSP.Types.Location | |
Eq Location | |
Ord Location | |
Defined in Language.LSP.Types.Location | |
Hashable Location | |
Defined in Language.LSP.Types.Location | |
HasLocation DiagnosticRelatedInformation Location | |
Defined in Language.LSP.Types.Lens Methods | |
HasLocation SymbolInformation Location | |
Defined in Language.LSP.Types.Lens Methods | |
HasRange Location Range | |
HasUri Location Uri | |
type Rep Location | |
Defined in Language.LSP.Types.Location type Rep Location = D1 ('MetaData "Location" "Language.LSP.Types.Location" "lsp-types-1.6.0.0-CwkG0vqR0ei5wn5TdsryfP" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) (S1 ('MetaSel ('Just "_uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Uri) :*: S1 ('MetaSel ('Just "_range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Range))) |
data DiagnosticSeverity #
Instances
data Diagnostic #
Constructors
Diagnostic | |
Fields
|
Instances
Constructors
Range | |
Fields
|
Instances
A position in a document. Note that the character offsets in a line are given in UTF-16 code units, *not* Unicode code points.
Constructors
Position | |
Fields
|
Instances
data NormalizedUri #
Constructors
NormalizedUri !Int !Text |
Instances
data WorkspaceEdit #
Constructors
WorkspaceEdit | |
Fields
|
Instances
positionInRange :: Position -> Range -> Bool #
positionInRange
returns true if the given Position
is in the Range
.
data Method (f :: From) (t :: MethodType) where #
Constructors
Instances
GCompare IdeNotification | |
Defined in Ide.Types Methods gcompare :: forall (a :: k) (b :: k). IdeNotification a -> IdeNotification b -> GOrdering a b # | |
GCompare IdeMethod | |
GEq IdeNotification | |
Defined in Ide.Types Methods geq :: forall (a :: k) (b :: k). IdeNotification a -> IdeNotification b -> Maybe (a :~: b) # | |
GEq IdeMethod | |
IxOrd (LspId :: Method f 'Request -> Type) | |
GCompare (SMethod :: Method f t -> Type) | |
GEq (SMethod :: Method f t -> Type) | |
type Base (LspId :: Method f 'Request -> Type) | |
mEqClient :: forall {t1 :: MethodType} {t2 :: MethodType} (m1 :: Method 'FromClient t1) (m2 :: Method 'FromClient t2). SClientMethod m1 -> SClientMethod m2 -> Maybe (Either (CustomEq m1 m2) (m1 :~~: m2)) #
Heterogeneous equality on singleton client methods
mEqServer :: forall {t1 :: MethodType} {t2 :: MethodType} (m1 :: Method 'FromServer t1) (m2 :: Method 'FromServer t2). SServerMethod m1 -> SServerMethod m2 -> Maybe (Either (CustomEq m1 m2) (m1 :~~: m2)) #
Heterogeneous equality on singleton server methods
runEq :: forall (t1 :: MethodType) (t2 :: MethodType) (f :: From) (m1 :: Method f t1) (m2 :: Method f t2). t1 ~ t2 => (SMethod m1 -> SMethod m2 -> Maybe (Either (CustomEq m1 m2) (m1 :~~: m2))) -> SMethod m1 -> SMethod m2 -> Maybe (m1 :~~: m2) #
splitServerMethod :: forall {t :: MethodType} (m :: Method 'FromServer t). SServerMethod m -> ServerNotOrReq m #
splitClientMethod :: forall {t :: MethodType} (m :: Method 'FromClient t). SClientMethod m -> ClientNotOrReq m #
serverMethodJSON :: forall {t :: MethodType} (m :: Method 'FromServer t) x. SServerMethod m -> (ToJSON (ServerMessage m) => x) -> x #
clientMethodJSON :: forall {t :: MethodType} (m :: Method 'FromClient t) x. SClientMethod m -> (ToJSON (ClientMessage m) => x) -> x #
serverResponseJSON :: forall (m :: Method 'FromServer 'Request) x. SServerMethod m -> (HasJSON (ResponseMessage m) => x) -> x #
clientResponseJSON :: forall (m :: Method 'FromClient 'Request) x. SClientMethod m -> (HasJSON (ResponseMessage m) => x) -> x #
parseClientMessage :: forall (a :: Method 'FromServer 'Request -> Type). LookupFunc 'FromServer a -> Value -> Parser (FromClientMessage' a) #
parseServerMessage :: forall (a :: Method 'FromClient 'Request -> Type). LookupFunc 'FromClient a -> Value -> Parser (FromServerMessage' a) #
fromClientReq :: forall (m :: Method 'FromClient 'Request). Message m ~ RequestMessage m => RequestMessage m -> FromClientMessage #
fromClientNot :: forall (m :: Method 'FromClient 'Notification). Message m ~ NotificationMessage m => NotificationMessage m -> FromClientMessage #
fromServerReq :: forall (m :: Method 'FromServer 'Request). Message m ~ RequestMessage m => RequestMessage m -> FromServerMessage #
fromServerNot :: forall (m :: Method 'FromServer 'Notification). Message m ~ NotificationMessage m => NotificationMessage m -> FromServerMessage #
data FromServerMessage' (a :: Method 'FromClient 'Request -> Type) where #
Constructors
FromServerMess :: forall (t :: MethodType) (m :: Method 'FromServer t) (a :: Method 'FromClient 'Request -> Type). SMethod m -> Message m -> FromServerMessage' a | |
FromServerRsp :: forall (m :: Method 'FromClient 'Request) (a :: Method 'FromClient 'Request -> Type). a m -> ResponseMessage m -> FromServerMessage' a |
Instances
ToJSON FromServerMessage | |
Defined in Language.LSP.Types.Parsing Methods toJSON :: FromServerMessage -> Value # toEncoding :: FromServerMessage -> Encoding # toJSONList :: [FromServerMessage] -> Value # toEncodingList :: [FromServerMessage] -> Encoding # | |
Show FromServerMessage | |
Defined in Language.LSP.Types.Parsing Methods showsPrec :: Int -> FromServerMessage -> ShowS # show :: FromServerMessage -> String # showList :: [FromServerMessage] -> ShowS # | |
Eq FromServerMessage | |
Defined in Language.LSP.Types.Parsing Methods (==) :: FromServerMessage -> FromServerMessage -> Bool # (/=) :: FromServerMessage -> FromServerMessage -> Bool # |
type FromServerMessage = FromServerMessage' (SMethod :: Method 'FromClient 'Request -> Type) #
data FromClientMessage' (a :: Method 'FromServer 'Request -> Type) where #
Constructors
FromClientMess :: forall (t :: MethodType) (m :: Method 'FromClient t) (a :: Method 'FromServer 'Request -> Type). SMethod m -> Message m -> FromClientMessage' a | |
FromClientRsp :: forall (m :: Method 'FromServer 'Request) (a :: Method 'FromServer 'Request -> Type). a m -> ResponseMessage m -> FromClientMessage' a |
Instances
ToJSON FromClientMessage | |
Defined in Language.LSP.Types.Parsing Methods toJSON :: FromClientMessage -> Value # toEncoding :: FromClientMessage -> Encoding # toJSONList :: [FromClientMessage] -> Value # toEncodingList :: [FromClientMessage] -> Encoding # |
type FromClientMessage = FromClientMessage' (SMethod :: Method 'FromServer 'Request -> Type) #
type LookupFunc (f :: From) (a :: Method f 'Request -> Type) = forall (m :: Method f 'Request). LspId m -> Maybe (SMethod m, a m) #
data ClientNotOrReq (m :: Method 'FromClient t) where #
Constructors
IsClientNot :: forall (m1 :: Method 'FromClient 'Notification). (HasJSON (ClientMessage m1), Message m1 ~ NotificationMessage m1) => ClientNotOrReq m1 | |
IsClientReq :: forall (m1 :: Method 'FromClient 'Request). (HasJSON (ClientMessage m1), HasJSON (ResponseMessage m1), Message m1 ~ RequestMessage m1) => ClientNotOrReq m1 | |
IsClientEither :: forall {t :: MethodType}. ClientNotOrReq ('CustomMethod :: Method 'FromClient t) |
data ServerNotOrReq (m :: Method 'FromServer t) where #
Constructors
IsServerNot :: forall (m1 :: Method 'FromServer 'Notification). (HasJSON (ServerMessage m1), Message m1 ~ NotificationMessage m1) => ServerNotOrReq m1 | |
IsServerReq :: forall (m1 :: Method 'FromServer 'Request). (HasJSON (ServerMessage m1), HasJSON (ResponseMessage m1), Message m1 ~ RequestMessage m1) => ServerNotOrReq m1 | |
IsServerEither :: forall {t :: MethodType}. ServerNotOrReq ('CustomMethod :: Method 'FromServer t) |
data CustomEq (m1 :: Method f t1) (m2 :: Method f t2) where #
Given a witness that two custom methods are of the same type, produce a witness that the methods are the same
Constructors
CustomEq | |
Fields
|
data ResponseMessage (m :: Method f 'Request) #
Either result or error must be Just.
Constructors
ResponseMessage | |
Fields
|
Instances
type family Message (m :: Method f t) where ... #
Map a method to the Request/Notification type with the correct payload
Equations
Message ('CustomMethod :: Method f t) = CustomMessage f t | |
Message (m :: Method f 'Request) = RequestMessage m | |
Message (m :: Method f 'Notification) = NotificationMessage m |
type ClientMessage (m :: Method 'FromClient t) = Message m #
type ServerMessage (m :: Method 'FromServer t) = Message m #
addNullField :: String -> Value -> Value #
Replace a missing field in an object with a null field, to simplify parsing This is a hack to allow other types than Maybe to work like Maybe in allowing the field to be missing. See also this issue: https://github.com/haskell/aeson/issues/646
type family MessageParams (m :: Method f t) where ... #
Map a method to the message payload type
Equations
type family ResponseResult (m :: Method f 'Request) where ... #
Map a request method to the response payload type
Equations
data NotificationMessage (m :: Method f 'Notification) #
Constructors
NotificationMessage | |
Instances
data RequestMessage (m :: Method f 'Request) #
Constructors
RequestMessage | |
Instances
data CustomMessage (f :: From) (t :: MethodType) where #
A custom message data type is needed to distinguish between notifications and requests, since a CustomMethod can be both!
Constructors
ReqMess :: forall (f :: From). RequestMessage ('CustomMethod :: Method f 'Request) -> CustomMessage f 'Request | |
NotMess :: forall (f :: From). NotificationMessage ('CustomMethod :: Method f 'Notification) -> CustomMessage f 'Notification |
Instances
FromJSON (CustomMessage p 'Notification) | |
Defined in Language.LSP.Types.Message Methods parseJSON :: Value -> Parser (CustomMessage p 'Notification) # parseJSONList :: Value -> Parser [CustomMessage p 'Notification] # | |
FromJSON (CustomMessage p 'Request) | |
Defined in Language.LSP.Types.Message Methods parseJSON :: Value -> Parser (CustomMessage p 'Request) # parseJSONList :: Value -> Parser [CustomMessage p 'Request] # | |
ToJSON (CustomMessage p t) | |
Defined in Language.LSP.Types.Message Methods toJSON :: CustomMessage p t -> Value # toEncoding :: CustomMessage p t -> Encoding # toJSONList :: [CustomMessage p t] -> Value # toEncodingList :: [CustomMessage p t] -> Encoding # | |
Show (CustomMessage p t) | |
Defined in Language.LSP.Types.Message Methods showsPrec :: Int -> CustomMessage p t -> ShowS # show :: CustomMessage p t -> String # showList :: [CustomMessage p t] -> ShowS # |
Constructors
ParseError | |
InvalidRequest | |
MethodNotFound | |
InvalidParams | |
InternalError | |
ServerErrorStart | |
ServerErrorEnd | |
ServerNotInitialized | |
UnknownErrorCode | |
RequestCancelled | |
ContentModified | |
ServerCancelled | |
RequestFailed | |
ErrorCodeCustom Int32 | Note: server error codes are reserved from -32099 to -32000 |
Instances
FromJSON ErrorCode | |
ToJSON ErrorCode | |
Defined in Language.LSP.Types.Message | |
Read ErrorCode | |
Show ErrorCode | |
Eq ErrorCode | |
HasCode ResponseError ErrorCode | |
Defined in Language.LSP.Types.Lens Methods |
data ResponseError #
Instances
data InitializedParams #
Constructors
InitializedParams |
Instances
data InitializeResult #
Constructors
InitializeResult | |
Fields
|
Instances
data ServerInfo #
Constructors
ServerInfo | |
Instances
FromJSON ServerInfo | |
Defined in Language.LSP.Types.Initialize | |
ToJSON ServerInfo | |
Defined in Language.LSP.Types.Initialize Methods toJSON :: ServerInfo -> Value # toEncoding :: ServerInfo -> Encoding # toJSONList :: [ServerInfo] -> Value # toEncodingList :: [ServerInfo] -> Encoding # | |
Read ServerInfo | |
Defined in Language.LSP.Types.Initialize Methods readsPrec :: Int -> ReadS ServerInfo # readList :: ReadS [ServerInfo] # readPrec :: ReadPrec ServerInfo # readListPrec :: ReadPrec [ServerInfo] # | |
Show ServerInfo | |
Defined in Language.LSP.Types.Initialize Methods showsPrec :: Int -> ServerInfo -> ShowS # show :: ServerInfo -> String # showList :: [ServerInfo] -> ShowS # | |
Eq ServerInfo | |
Defined in Language.LSP.Types.Initialize | |
HasName ServerInfo Text | |
Defined in Language.LSP.Types.Lens Methods name :: Lens' ServerInfo Text # | |
HasServerInfo InitializeResult (Maybe ServerInfo) | |
Defined in Language.LSP.Types.Lens Methods | |
HasVersion ServerInfo (Maybe Text) | |
Defined in Language.LSP.Types.Lens |
data InitializeError #
Constructors
InitializeError | |
Instances
FromJSON InitializeError | |
Defined in Language.LSP.Types.Initialize Methods parseJSON :: Value -> Parser InitializeError # parseJSONList :: Value -> Parser [InitializeError] # | |
ToJSON InitializeError | |
Defined in Language.LSP.Types.Initialize Methods toJSON :: InitializeError -> Value # toEncoding :: InitializeError -> Encoding # toJSONList :: [InitializeError] -> Value # toEncodingList :: [InitializeError] -> Encoding # | |
Read InitializeError | |
Defined in Language.LSP.Types.Initialize Methods readsPrec :: Int -> ReadS InitializeError # readList :: ReadS [InitializeError] # | |
Show InitializeError | |
Defined in Language.LSP.Types.Initialize Methods showsPrec :: Int -> InitializeError -> ShowS # show :: InitializeError -> String # showList :: [InitializeError] -> ShowS # | |
Eq InitializeError | |
Defined in Language.LSP.Types.Initialize Methods (==) :: InitializeError -> InitializeError -> Bool # (/=) :: InitializeError -> InitializeError -> Bool # | |
HasRetry InitializeError Bool | |
Defined in Language.LSP.Types.Lens Methods |
data InitializeParams #
Constructors
InitializeParams | |
Fields |
Instances
Constructors
TraceOff | |
TraceMessages | |
TraceVerbose |
data ClientInfo #
Constructors
ClientInfo | |
Instances
FromJSON ClientInfo | |
Defined in Language.LSP.Types.Initialize | |
ToJSON ClientInfo | |
Defined in Language.LSP.Types.Initialize Methods toJSON :: ClientInfo -> Value # toEncoding :: ClientInfo -> Encoding # toJSONList :: [ClientInfo] -> Value # toEncodingList :: [ClientInfo] -> Encoding # | |
Read ClientInfo | |
Defined in Language.LSP.Types.Initialize Methods readsPrec :: Int -> ReadS ClientInfo # readList :: ReadS [ClientInfo] # readPrec :: ReadPrec ClientInfo # readListPrec :: ReadPrec [ClientInfo] # | |
Show ClientInfo | |
Defined in Language.LSP.Types.Initialize Methods showsPrec :: Int -> ClientInfo -> ShowS # show :: ClientInfo -> String # showList :: [ClientInfo] -> ShowS # | |
Eq ClientInfo | |
Defined in Language.LSP.Types.Initialize | |
HasName ClientInfo Text | |
Defined in Language.LSP.Types.Lens Methods name :: Lens' ClientInfo Text # | |
HasClientInfo InitializeParams (Maybe ClientInfo) | |
Defined in Language.LSP.Types.Lens Methods | |
HasVersion ClientInfo (Maybe Text) | |
Defined in Language.LSP.Types.Lens |
data UnregistrationParams #
Constructors
UnregistrationParams | |
Fields
|
Instances
data Unregistration #
General parameters to unregister a capability.
Constructors
Unregistration | |
Fields
|
Instances
regHelper :: forall {t :: MethodType} (m :: Method 'FromClient t) x. SMethod m -> ((Show (RegistrationOptions m), ToJSON (RegistrationOptions m), FromJSON (RegistrationOptions m)) => x) -> x #
data SomeRegistration #
Constructors
SomeRegistration (Registration m) |
Instances
FromJSON SomeRegistration | |
Defined in Language.LSP.Types.Registration Methods parseJSON :: Value -> Parser SomeRegistration # parseJSONList :: Value -> Parser [SomeRegistration] # | |
ToJSON SomeRegistration | |
Defined in Language.LSP.Types.Registration Methods toJSON :: SomeRegistration -> Value # toEncoding :: SomeRegistration -> Encoding # toJSONList :: [SomeRegistration] -> Value # toEncodingList :: [SomeRegistration] -> Encoding # | |
Show SomeRegistration | |
Defined in Language.LSP.Types.Registration Methods showsPrec :: Int -> SomeRegistration -> ShowS # show :: SomeRegistration -> String # showList :: [SomeRegistration] -> ShowS # | |
Eq SomeRegistration | |
Defined in Language.LSP.Types.Registration Methods (==) :: SomeRegistration -> SomeRegistration -> Bool # (/=) :: SomeRegistration -> SomeRegistration -> Bool # | |
HasRegistrations RegistrationParams (List SomeRegistration) | |
Defined in Language.LSP.Types.Lens Methods registrations :: Lens' RegistrationParams (List SomeRegistration) # |
data RegistrationParams #
Constructors
RegistrationParams | |
Fields |
Instances
type family RegistrationOptions (m :: Method 'FromClient t) where ... #
Matches up the registration options for a specific method
Equations
data Registration (m :: Method 'FromClient t) #
Constructors
Registration | |
Fields
|
Instances
data WorkspaceSymbolParams #
Constructors
WorkspaceSymbolParams | |
Fields |
Instances
data WorkspaceSymbolRegistrationOptions #
Constructors
WorkspaceSymbolRegistrationOptions | |
Fields |
Instances
data WorkspaceSymbolOptions #
Constructors
WorkspaceSymbolOptions | |
Fields |
Instances
data WorkspaceSymbolClientCapabilities #
Constructors
WorkspaceSymbolClientCapabilities | |
Fields
|
Instances
data WorkspaceSymbolTagClientCapabilities #
Constructors
WorkspaceSymbolTagClientCapabilities | |
Instances
data WorkspaceSymbolKindClientCapabilities #
Constructors
WorkspaceSymbolKindClientCapabilities | |
Fields
|
Instances
data DidChangeWorkspaceFoldersParams #
Constructors
DidChangeWorkspaceFoldersParams | |
Fields
|
Instances
data WorkspaceFoldersChangeEvent #
The workspace folder change event.
Constructors
WorkspaceFoldersChangeEvent | |
Fields
|
Instances
data WorkspaceFolder #
Constructors
WorkspaceFolder | |
Instances
data CodeAction #
A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
A CodeAction must set either CodeAction
and/or a CodeAction
. If both are supplied,
the CodeAction
is applied first, then the CodeAction
is executed.
Constructors
CodeAction | |
Fields
|
Instances
Instances
FromJSON Reason | |
ToJSON Reason | |
Defined in Language.LSP.Types.CodeAction | |
Read Reason | |
Show Reason | |
Eq Reason | |
HasDisabled CodeAction (Maybe Reason) | |
Defined in Language.LSP.Types.Lens |
data CodeActionParams #
Constructors
CodeActionParams | |
Instances
data CodeActionContext #
Contains additional diagnostic information about the context in which a code action is run.
Constructors
CodeActionContext | |
Fields
|
Instances
data CodeActionRegistrationOptions #
Constructors
CodeActionRegistrationOptions | |
Fields |
Instances
data CodeActionOptions #
Constructors
CodeActionOptions | |
Fields |
Instances
data CodeActionClientCapabilities #
Constructors
CodeActionClientCapabilities | |
Fields
|
Instances
data CodeActionResolveClientCapabilities #
Constructors
CodeActionResolveClientCapabilities | |
Fields
|
Instances
data CodeActionLiteralSupport #
Constructors
CodeActionLiteralSupport | |
Fields
|
Instances
specCodeActionKinds :: [CodeActionKind] #
The CodeActionKind
s listed in the LSP spec specifically.
codeActionKindSubsumes :: CodeActionKind -> CodeActionKind -> Bool #
Does the first CodeActionKind
subsume the other one, hierarchically. Reflexive.
data CodeActionKind #
Constructors
CodeActionEmpty | Empty kind. |
CodeActionQuickFix | Base kind for quickfix actions: |
CodeActionRefactor | Base kind for refactoring actions: |
CodeActionRefactorExtract | Base kind for refactoring extraction actions:
|
CodeActionRefactorInline | Base kind for refactoring inline actions: Example inline actions:
|
CodeActionRefactorRewrite | Base kind for refactoring rewrite actions: Example rewrite actions:
|
CodeActionSource | Base kind for source actions: Source code actions apply to the entire file. |
CodeActionSourceOrganizeImports | Base kind for an organize imports source action: |
CodeActionUnknown Text |
Instances
data CodeActionKindClientCapabilities #
Constructors
CodeActionKindClientCapabilities | |
Fields
|
Instances
data CompletionParams #
Constructors
CompletionParams | |
Instances
data CompletionContext #
Constructors
CompletionContext | |
Fields
|
Instances
data CompletionRegistrationOptions #
Constructors
CompletionRegistrationOptions | |
Fields |
Instances
data CompletionOptions #
Constructors
CompletionOptions | |
Fields
|
Instances
data CompletionTriggerKind #
How a completion was triggered
Constructors
CtInvoked | Completion was triggered by typing an identifier (24x7 code complete), manual invocation (e.g Ctrl+Space) or via API. |
CtTriggerCharacter | Completion was triggered by a trigger character specified by
the |
CtTriggerForIncompleteCompletions | Completion was re-triggered as the current completion list is incomplete. |
CtUnknown Scientific | An unknown |
Instances
data CompletionList #
Represents a collection of CompletionItem
s to be presented in the editor.
Constructors
CompletionList | |
Fields
|
Instances
data CompletionItem #
Constructors
CompletionItem | |
Fields
|
Instances
data CompletionEdit #
Instances
FromJSON CompletionEdit | |
Defined in Language.LSP.Types.Completion Methods parseJSON :: Value -> Parser CompletionEdit # parseJSONList :: Value -> Parser [CompletionEdit] # | |
ToJSON CompletionEdit | |
Defined in Language.LSP.Types.Completion Methods toJSON :: CompletionEdit -> Value # toEncoding :: CompletionEdit -> Encoding # toJSONList :: [CompletionEdit] -> Value # toEncodingList :: [CompletionEdit] -> Encoding # | |
Read CompletionEdit | |
Defined in Language.LSP.Types.Completion Methods readsPrec :: Int -> ReadS CompletionEdit # readList :: ReadS [CompletionEdit] # | |
Show CompletionEdit | |
Defined in Language.LSP.Types.Completion Methods showsPrec :: Int -> CompletionEdit -> ShowS # show :: CompletionEdit -> String # showList :: [CompletionEdit] -> ShowS # | |
Eq CompletionEdit | |
Defined in Language.LSP.Types.Completion Methods (==) :: CompletionEdit -> CompletionEdit -> Bool # (/=) :: CompletionEdit -> CompletionEdit -> Bool # | |
HasTextEdit CompletionItem (Maybe CompletionEdit) | |
Defined in Language.LSP.Types.Lens Methods |
data InsertReplaceEdit #
Constructors
InsertReplaceEdit | |
Instances
data InsertTextFormat #
Constructors
PlainText | The primary text to be inserted is treated as a plain string. |
Snippet | The primary text to be inserted is treated as a snippet. A snippet can define tab stops and placeholders with `$1`, `$2` and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Placeholders with equal identifiers are linked, that is typing in one will update others too. See also: https://github.com/Microsoft/vscode/blob/master/src/vs/editor/contrib/snippet/common/snippet.md |
Instances
data CompletionDoc #
Constructors
CompletionDocString Text | |
CompletionDocMarkup MarkupContent |
Instances
data CompletionClientCapabilities #
Constructors
CompletionClientCapabilities | |
Fields
|
Instances
data CompletionItemKindClientCapabilities #
Constructors
CompletionItemKindClientCapabilities | |
Fields
|
Instances
data CompletionItemClientCapabilities #
Constructors
CompletionItemClientCapabilities | |
Fields
|
Instances
data InsertTextMode #
How whitespace and indentation is handled during completion item insertion.
Since: lsp-types-3.16.0
Constructors
AsIs | The insertion or replace strings is taken as it is. If the value is multi line the lines below the cursor will be inserted using the indentation defined in the string value. The client will not apply any kind of adjustments to the string. |
AdjustIndentation | The editor adjusts leading whitespace of new lines so that they match the indentation up to the cursor of the line for which the item is accepted. Consider a line like this: 2tabscursor3tabsfoo. Accepting a multi line completion item is indented using 2 tabs and all following lines inserted will be indented using 2 tabs as well. |
Instances
data CompletionItemInsertTextModeClientCapabilities #
Constructors
CompletionItemInsertTextModeClientCapabilities | |
Fields |
Instances
data CompletionItemResolveClientCapabilities #
Constructors
CompletionItemResolveClientCapabilities | |
Fields
|
Instances
data CompletionItemKind #
Constructors
Instances
data CompletionItemTag #
Constructors
CitDeprecated | Render a completion as obsolete, usually using a strike-out. |
CitUnknown Scientific |
Instances
data CompletionItemTagsClientCapabilities #
Constructors
CompletionItemTagsClientCapabilities | |
Fields
|
Instances
data ColorPresentation #
Constructors
ColorPresentation | |
Fields
|
Instances
data ColorPresentationParams #
Constructors
ColorPresentationParams | |
Fields |
Instances
data ColorInformation #
Constructors
ColorInformation | |
Instances
Represents a color in RGBA space.
Constructors
Color | |
Instances
FromJSON Color | |
ToJSON Color | |
Defined in Language.LSP.Types.DocumentColor | |
Read Color | |
Show Color | |
Eq Color | |
HasAlpha Color Float | |
HasBlue Color Float | |
HasColor ColorInformation Color | |
Defined in Language.LSP.Types.Lens Methods | |
HasColor ColorPresentationParams Color | |
Defined in Language.LSP.Types.Lens Methods | |
HasGreen Color Float | |
HasRed Color Float | |
data DocumentColorParams #
Constructors
DocumentColorParams | |
Instances
data DocumentColorRegistrationOptions #
Constructors
DocumentColorRegistrationOptions | |
Fields |
Instances
data DocumentColorOptions #
Constructors
DocumentColorOptions | |
Fields |
Instances
data DocumentColorClientCapabilities #
Constructors
DocumentColorClientCapabilities | |
Fields
|
Instances
editTextEdit :: TextEdit -> TextEdit -> TextEdit #
editTextEdit
outer
inner
applies inner
to the text inside outer
.
applyTextEdit :: TextEdit -> Text -> Text #
data ApplyWorkspaceEditResponseBody #
Constructors
ApplyWorkspaceEditResponseBody | |
Fields
|
Instances
data ApplyWorkspaceEditParams #
Constructors
ApplyWorkspaceEditParams | |
Fields
|
Instances
data WorkspaceEditClientCapabilities #
Constructors
WorkspaceEditClientCapabilities | |
Fields
|
Instances
data ResourceOperationKind #
Constructors
ResourceOperationCreate | Supports creating new files and folders. |
ResourceOperationRename | Supports renaming existing files and folders. |
ResourceOperationDelete | Supports deleting existing files and folders. |
Instances
data FailureHandlingKind #
Constructors
FailureHandlingAbort | Applying the workspace change is simply aborted if one of the changes provided fails. All operations executed before the failing operation stay executed. |
FailureHandlingTransactional | All operations are executed transactional. That means they either all succeed or no changes at all are applied to the workspace. |
FailureHandlingTextOnlyTransactional | If the workspace edit contains only textual file changes they are executed transactional. If resource changes (create, rename or delete file) are part of the change the failure handling strategy is abort. |
FailureHandlingUndo | The client tries to undo the operations already executed. But there is no guarantee that this is succeeding. |
Instances
data WorkspaceEditChangeAnnotationClientCapabilities #
Constructors
WorkspaceEditChangeAnnotationClientCapabilities | |
Fields
|
Instances
data DeleteFile #
Delete file operation
Constructors
DeleteFile | |
Fields
|
Instances
type DocumentChange = TextDocumentEdit |? (CreateFile |? (RenameFile |? DeleteFile)) #
`TextDocumentEdit |? CreateFile |? RenameFile |? DeleteFile` is a bit mouthful, here's the synonym
data RenameFile #
Rename file operation
Constructors
RenameFile | |
Fields
|
Instances
data DeleteFileOptions #
Constructors
DeleteFileOptions | |
Fields
|
Instances
data CreateFile #
Create file operation
Constructors
CreateFile | |
Fields
|
Instances
data RenameFileOptions #
Constructors
RenameFileOptions | |
Fields
|
Instances
data CreateFileOptions #
Options to create a file.
Constructors
CreateFileOptions | |
Fields
|
Instances
data TextDocumentEdit #
Constructors
TextDocumentEdit | |
Instances
data AnnotatedTextEdit #
Constructors
AnnotatedTextEdit | |
Fields |
Instances
newtype ChangeAnnotationIdentifier #
An identifier referring to a change annotation managed by a workspace edit.
Since: lsp-types-3.16.0
Constructors
ChangeAnnotationIdentifierId Text |
Instances
data ChangeAnnotation #
Additional information that describes document changes.
Since: lsp-types-3.16.0
Constructors
ChangeAnnotation | |
Fields
|
Instances
Instances
FromJSON TextEdit | |
ToJSON TextEdit | |
Defined in Language.LSP.Types.WorkspaceEdit | |
Read TextEdit | |
Show TextEdit | |
Eq TextEdit | |
HasNewText TextEdit Text | |
HasRange TextEdit Range | |
HasAdditionalTextEdits CompletionItem (Maybe (List TextEdit)) | |
Defined in Language.LSP.Types.Lens Methods additionalTextEdits :: Lens' CompletionItem (Maybe (List TextEdit)) # | |
HasAdditionalTextEdits ColorPresentation (Maybe (List TextEdit)) | |
Defined in Language.LSP.Types.Lens Methods additionalTextEdits :: Lens' ColorPresentation (Maybe (List TextEdit)) # | |
HasChanges WorkspaceEdit (Maybe WorkspaceEditMap) | |
Defined in Language.LSP.Types.Lens Methods | |
HasEdits TextDocumentEdit (List (TextEdit |? AnnotatedTextEdit)) | |
Defined in Language.LSP.Types.Lens Methods edits :: Lens' TextDocumentEdit (List (TextEdit |? AnnotatedTextEdit)) # | |
HasTextEdit ColorPresentation (Maybe TextEdit) | |
Defined in Language.LSP.Types.Lens |
data LogMessageParams #
Constructors
LogMessageParams | |
Fields
|
Instances
data ShowDocumentResult #
The result of an show document request.
Since: lsp-types-3.16.0
Constructors
ShowDocumentResult | |
Instances
data ShowDocumentParams #
Params to show a document.
Since: lsp-types-3.16.0
Constructors
ShowDocumentParams | |
Fields
|
Instances
data ShowMessageRequestParams #
Constructors
ShowMessageRequestParams | |
Fields
|
Instances
data MessageActionItem #
Constructors
MessageActionItem | |
Instances
data MessageType #
Instances
data ShowMessageParams #
Constructors
ShowMessageParams | |
Fields
|
Instances
data DidChangeWatchedFilesParams #
Constructors
DidChangeWatchedFilesParams | |
Instances
data FileChangeType #
The file event type.
Constructors
FcCreated | The file got created. |
FcChanged | The file got changed. |
FcDeleted | The file got deleted. |
Instances
FromJSON FileChangeType | |
Defined in Language.LSP.Types.WatchedFiles Methods parseJSON :: Value -> Parser FileChangeType # parseJSONList :: Value -> Parser [FileChangeType] # | |
ToJSON FileChangeType | |
Defined in Language.LSP.Types.WatchedFiles Methods toJSON :: FileChangeType -> Value # toEncoding :: FileChangeType -> Encoding # toJSONList :: [FileChangeType] -> Value # toEncodingList :: [FileChangeType] -> Encoding # | |
Read FileChangeType | |
Defined in Language.LSP.Types.WatchedFiles Methods readsPrec :: Int -> ReadS FileChangeType # readList :: ReadS [FileChangeType] # | |
Show FileChangeType | |
Defined in Language.LSP.Types.WatchedFiles Methods showsPrec :: Int -> FileChangeType -> ShowS # show :: FileChangeType -> String # showList :: [FileChangeType] -> ShowS # | |
Eq FileChangeType | |
Defined in Language.LSP.Types.WatchedFiles Methods (==) :: FileChangeType -> FileChangeType -> Bool # (/=) :: FileChangeType -> FileChangeType -> Bool # | |
HasXtype FileEvent FileChangeType | |
Defined in Language.LSP.Types.Lens Methods |
An event describing a file change.
Constructors
FileEvent | |
Fields
|
Instances
FromJSON FileEvent | |
ToJSON FileEvent | |
Defined in Language.LSP.Types.WatchedFiles | |
Read FileEvent | |
Show FileEvent | |
Eq FileEvent | |
HasUri FileEvent Uri | |
HasXtype FileEvent FileChangeType | |
Defined in Language.LSP.Types.Lens Methods | |
HasChanges DidChangeWatchedFilesParams (List FileEvent) | |
Defined in Language.LSP.Types.Lens |
data DidChangeWatchedFilesRegistrationOptions #
Describe options to be used when registering for file system change events.
Constructors
DidChangeWatchedFilesRegistrationOptions | |
Fields
|
Instances
data FileSystemWatcher #
Constructors
FileSystemWatcher | |
Fields
|
Instances
Constructors
WatchKind | |
Fields
|
Instances
FromJSON WatchKind | |
ToJSON WatchKind | |
Defined in Language.LSP.Types.WatchedFiles | |
Read WatchKind | |
Show WatchKind | |
Eq WatchKind | |
HasWatchChange WatchKind Bool | |
Defined in Language.LSP.Types.Lens Methods | |
HasWatchCreate WatchKind Bool | |
Defined in Language.LSP.Types.Lens Methods | |
HasWatchDelete WatchKind Bool | |
Defined in Language.LSP.Types.Lens Methods | |
HasKind FileSystemWatcher (Maybe WatchKind) | |
Defined in Language.LSP.Types.Lens |
data DidChangeWatchedFilesClientCapabilities #
Constructors
DidChangeWatchedFilesClientCapabilities | |
Fields
|
Instances
data CallHierarchyOutgoingCall #
Constructors
CallHierarchyOutgoingCall | |
Fields
|
Instances
data CallHierarchyOutgoingCallsParams #
Constructors
CallHierarchyOutgoingCallsParams | |
Instances
data CallHierarchyIncomingCall #
Constructors
CallHierarchyIncomingCall | |
Fields
|
Instances
data CallHierarchyIncomingCallsParams #
Constructors
CallHierarchyIncomingCallsParams | |
Instances
data CallHierarchyItem #
Constructors
CallHierarchyItem | |
Fields
|
Instances
data CallHierarchyPrepareParams #
Constructors
CallHierarchyPrepareParams | |
Fields |
Instances
data CallHierarchyRegistrationOptions #
Constructors
CallHierarchyRegistrationOptions | |
Fields |
Instances
data CallHierarchyOptions #
Constructors
CallHierarchyOptions | |
Fields |
Instances
data CallHierarchyClientCapabilities #
Constructors
CallHierarchyClientCapabilities | |
Fields |
Instances
data CancelParams #
Constructors
CancelParams | |
Instances
FromJSON CancelParams | |
Defined in Language.LSP.Types.Cancellation | |
ToJSON CancelParams | |
Defined in Language.LSP.Types.Cancellation Methods toJSON :: CancelParams -> Value # toEncoding :: CancelParams -> Encoding # toJSONList :: [CancelParams] -> Value # toEncodingList :: [CancelParams] -> Encoding # | |
Read CancelParams | |
Defined in Language.LSP.Types.Cancellation Methods readsPrec :: Int -> ReadS CancelParams # readList :: ReadS [CancelParams] # | |
Show CancelParams | |
Defined in Language.LSP.Types.Cancellation Methods showsPrec :: Int -> CancelParams -> ShowS # show :: CancelParams -> String # showList :: [CancelParams] -> ShowS # | |
Eq CancelParams | |
Defined in Language.LSP.Types.Cancellation |
A code lens represents a command that should be shown along with source text, like the number of references, a way to run tests, etc.
A code lens is _unresolved_ when no command is associated to it. For performance reasons the creation of a code lens and resolving should be done in two stages.
Constructors
CodeLens | |
data CodeLensParams #
Constructors
CodeLensParams | |
Instances
data CodeLensRegistrationOptions #
Constructors
CodeLensRegistrationOptions | |
Fields |
Instances
data CodeLensOptions #
Constructors
CodeLensOptions | |
Fields |
Instances
data CodeLensClientCapabilities #
Constructors
CodeLensClientCapabilities | |
Fields
|
Instances
Constructors
Command | |
Instances
FromJSON Command | |
ToJSON Command | |
Defined in Language.LSP.Types.Command | |
Read Command | |
Show Command | |
Eq Command | |
HasCommand Command Text | |
HasTitle Command Text | |
HasArguments Command (Maybe (List Value)) | |
HasCommand CodeAction (Maybe Command) | |
Defined in Language.LSP.Types.Lens | |
HasCommand CodeLens (Maybe Command) | |
HasCommand CompletionItem (Maybe Command) | |
Defined in Language.LSP.Types.Lens |
data ExecuteCommandParams #
Constructors
ExecuteCommandParams | |
Fields
|
Instances
data ExecuteCommandRegistrationOptions #
Constructors
ExecuteCommandRegistrationOptions | |
Instances
data ExecuteCommandOptions #
Constructors
ExecuteCommandOptions | |
Instances
data ExecuteCommandClientCapabilities #
Constructors
ExecuteCommandClientCapabilities | |
Fields
|
Instances
data ConfigurationParams #
Constructors
ConfigurationParams | |
Fields |
Instances
data ConfigurationItem #
Constructors
ConfigurationItem | |
Instances
data DidChangeConfigurationParams #
Constructors
DidChangeConfigurationParams | |
Instances
data DidChangeConfigurationClientCapabilities #
Constructors
DidChangeConfigurationClientCapabilities | |
Fields
|
Instances
data DeclarationParams #
Constructors
DeclarationParams | |
Instances
data DeclarationRegistrationOptions #
Constructors
DeclarationRegistrationOptions | |
Fields |
Instances
data DeclarationOptions #
Constructors
DeclarationOptions | |
Fields |
Instances
data DeclarationClientCapabilities #
Constructors
DeclarationClientCapabilities | |
Fields
|
Instances
data DefinitionParams #
Constructors
DefinitionParams | |
Instances
data DefinitionRegistrationOptions #
Constructors
DefinitionRegistrationOptions | |
Fields |
Instances
data DefinitionOptions #
Constructors
DefinitionOptions | |
Fields |
Instances
data DefinitionClientCapabilities #
Constructors
DefinitionClientCapabilities | |
Fields
|
Instances
data PublishDiagnosticsParams #
Constructors
PublishDiagnosticsParams | |
Fields
|
Instances
data PublishDiagnosticsClientCapabilities #
Constructors
PublishDiagnosticsClientCapabilities | |
Fields
|
Instances
data PublishDiagnosticsTagsClientCapabilities #
Constructors
PublishDiagnosticsTagsClientCapabilities | |
Fields
|
Instances
type DiagnosticSource = Text #
data DiagnosticTag #
Constructors
DtUnnecessary | Unused or unnecessary code. Clients are allowed to render diagnostics with this tag faded out instead of having an error squiggle. |
DtDeprecated | Deprecated or obsolete code. Clients are allowed to rendered diagnostics with this tag strike through. |
Instances
data DiagnosticRelatedInformation #
Constructors
DiagnosticRelatedInformation | |
Instances
data DocumentHighlightKind #
Constructors
HkText | A textual occurrence. |
HkRead | Read-access of a symbol, like reading a variable. |
HkWrite | Write-access of a symbol, like writing to a variable. |
Instances
data DocumentHighlight #
A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.
Constructors
DocumentHighlight | |
Instances
data DocumentHighlightParams #
Constructors
DocumentHighlightParams | |
Instances
data DocumentHighlightRegistrationOptions #
Constructors
DocumentHighlightRegistrationOptions | |
Fields |
Instances
data DocumentHighlightOptions #
Constructors
DocumentHighlightOptions | |
Fields |
Instances
data DocumentHighlightClientCapabilities #
Constructors
DocumentHighlightClientCapabilities | |
Fields
|
Instances
data DocumentLink #
A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.
Constructors
DocumentLink | |
Fields
|
Instances
FromJSON DocumentLink | |
Defined in Language.LSP.Types.DocumentLink | |
ToJSON DocumentLink | |
Defined in Language.LSP.Types.DocumentLink Methods toJSON :: DocumentLink -> Value # toEncoding :: DocumentLink -> Encoding # toJSONList :: [DocumentLink] -> Value # toEncodingList :: [DocumentLink] -> Encoding # | |
Read DocumentLink | |
Defined in Language.LSP.Types.DocumentLink Methods readsPrec :: Int -> ReadS DocumentLink # readList :: ReadS [DocumentLink] # | |
Show DocumentLink | |
Defined in Language.LSP.Types.DocumentLink Methods showsPrec :: Int -> DocumentLink -> ShowS # show :: DocumentLink -> String # showList :: [DocumentLink] -> ShowS # | |
Eq DocumentLink | |
Defined in Language.LSP.Types.DocumentLink | |
HasRange DocumentLink Range | |
Defined in Language.LSP.Types.Lens Methods range :: Lens' DocumentLink Range # | |
HasTarget DocumentLink (Maybe Uri) | |
Defined in Language.LSP.Types.Lens | |
HasTooltip DocumentLink (Maybe Text) | |
Defined in Language.LSP.Types.Lens | |
HasXdata DocumentLink (Maybe Value) | |
Defined in Language.LSP.Types.Lens |
data DocumentLinkParams #
Constructors
DocumentLinkParams | |
Instances
data DocumentLinkRegistrationOptions #
Constructors
DocumentLinkRegistrationOptions | |
Fields |
Instances
data DocumentLinkOptions #
Constructors
DocumentLinkOptions | |
Fields |
Instances
data DocumentLinkClientCapabilities #
Constructors
DocumentLinkClientCapabilities | |
Fields
|
Instances
data SymbolInformation #
Represents information about programming constructs like variables, classes, interfaces etc.
Constructors
SymbolInformation | |
Fields
|
Instances
data DocumentSymbol #
Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.
Constructors
DocumentSymbol | |
Fields
|
Instances
data DocumentSymbolClientCapabilities #
Constructors
DocumentSymbolClientCapabilities | |
Fields
|
Instances
data DocumentSymbolTagClientCapabilities #
Constructors
DocumentSymbolTagClientCapabilities | |
Instances
data SymbolKind #
Constructors
Instances
Symbol tags are extra annotations that tweak the rendering of a symbol.
Since: lsp-types-3.16.0
Constructors
StDeprecated | Render a symbol as obsolete, usually using a strike-out. |
StUnknown Scientific |
Instances
FromJSON SymbolTag | |
ToJSON SymbolTag | |
Defined in Language.LSP.Types.DocumentSymbol | |
Read SymbolTag | |
Show SymbolTag | |
Eq SymbolTag | |
HasTags CallHierarchyItem (Maybe (List SymbolTag)) | |
Defined in Language.LSP.Types.Lens | |
HasTags DocumentSymbol (Maybe (List SymbolTag)) | |
Defined in Language.LSP.Types.Lens | |
HasTags SymbolInformation (Maybe (List SymbolTag)) | |
Defined in Language.LSP.Types.Lens |
data DocumentSymbolKindClientCapabilities #
Constructors
DocumentSymbolKindClientCapabilities | |
Fields
|
Instances
data DocumentSymbolParams #
Constructors
DocumentSymbolParams | |
Instances
data DocumentSymbolRegistrationOptions #
Constructors
DocumentSymbolRegistrationOptions | |
Fields |
Instances
data DocumentSymbolOptions #
Constructors
DocumentSymbolOptions | |
Instances
data FoldingRangeKind #
Enum of known range kinds
Constructors
FoldingRangeComment | Folding range for a comment |
FoldingRangeImports | Folding range for a imports or includes |
FoldingRangeRegion | Folding range for a region (e.g. #region) |
FoldingRangeUnknown Text | Folding range that haskell-lsp-types does not yet support |
Instances
data FoldingRange #
Represents a folding range.
Constructors
FoldingRange | |
Fields
|
Instances
data FoldingRangeParams #
Constructors
FoldingRangeParams | |
Instances
data FoldingRangeRegistrationOptions #
Constructors
FoldingRangeRegistrationOptions | |
Fields |
Instances
data FoldingRangeOptions #
Constructors
FoldingRangeOptions | |
Fields |
Instances
data FoldingRangeClientCapabilities #
Constructors
FoldingRangeClientCapabilities | |
Fields
|
Instances
data DocumentOnTypeFormattingParams #
Constructors
DocumentOnTypeFormattingParams | |
Fields |
Instances
data DocumentOnTypeFormattingRegistrationOptions #
Constructors
DocumentOnTypeFormattingRegistrationOptions | |
Fields |
Instances
data DocumentOnTypeFormattingOptions #
Constructors
DocumentOnTypeFormattingOptions | |
Fields
|
Instances
data DocumentOnTypeFormattingClientCapabilities #
Constructors
DocumentOnTypeFormattingClientCapabilities | |
Fields
|
Instances
data DocumentRangeFormattingParams #
Constructors
DocumentRangeFormattingParams | |
Fields |
Instances
data DocumentRangeFormattingRegistrationOptions #
Constructors
DocumentRangeFormattingRegistrationOptions | |
Fields |
Instances
data DocumentRangeFormattingOptions #
Constructors
DocumentRangeFormattingOptions | |
Fields |
Instances
data DocumentRangeFormattingClientCapabilities #
Constructors
DocumentRangeFormattingClientCapabilities | |
Fields
|
Instances
data DocumentFormattingParams #
Constructors
DocumentFormattingParams | |
Instances
data FormattingOptions #
Value-object describing what options formatting should use.
Constructors
FormattingOptions | |
Fields
|
Instances
data DocumentFormattingRegistrationOptions #
Constructors
DocumentFormattingRegistrationOptions | |
Fields |
Instances
data DocumentFormattingOptions #
Constructors
DocumentFormattingOptions | |
Fields |
Instances
data DocumentFormattingClientCapabilities #
Constructors
DocumentFormattingClientCapabilities | |
Fields
|
Instances
Instances
FromJSON Hover | |
ToJSON Hover | |
Defined in Language.LSP.Types.Hover | |
Read Hover | |
Show Hover | |
Eq Hover | |
HasContents Hover HoverContents | |
Defined in Language.LSP.Types.Lens Methods | |
HasRange Hover (Maybe Range) | |
data HoverContents #
Constructors
HoverContentsMS (List MarkedString) | |
HoverContents MarkupContent |
Instances
data MarkedString #
Constructors
PlainString Text | |
CodeString LanguageString |
Instances
FromJSON MarkedString | |
Defined in Language.LSP.Types.Hover | |
ToJSON MarkedString | |
Defined in Language.LSP.Types.Hover Methods toJSON :: MarkedString -> Value # toEncoding :: MarkedString -> Encoding # toJSONList :: [MarkedString] -> Value # toEncodingList :: [MarkedString] -> Encoding # | |
Read MarkedString | |
Defined in Language.LSP.Types.Hover Methods readsPrec :: Int -> ReadS MarkedString # readList :: ReadS [MarkedString] # | |
Show MarkedString | |
Defined in Language.LSP.Types.Hover Methods showsPrec :: Int -> MarkedString -> ShowS # show :: MarkedString -> String # showList :: [MarkedString] -> ShowS # | |
Eq MarkedString | |
Defined in Language.LSP.Types.Hover |
data LanguageString #
Constructors
LanguageString | |
Instances
data HoverParams #
Constructors
HoverParams | |
Fields |
Instances
FromJSON HoverParams | |
Defined in Language.LSP.Types.Hover | |
ToJSON HoverParams | |
Defined in Language.LSP.Types.Hover Methods toJSON :: HoverParams -> Value # toEncoding :: HoverParams -> Encoding # toJSONList :: [HoverParams] -> Value # toEncodingList :: [HoverParams] -> Encoding # | |
Read HoverParams | |
Defined in Language.LSP.Types.Hover Methods readsPrec :: Int -> ReadS HoverParams # readList :: ReadS [HoverParams] # readPrec :: ReadPrec HoverParams # readListPrec :: ReadPrec [HoverParams] # | |
Show HoverParams | |
Defined in Language.LSP.Types.Hover Methods showsPrec :: Int -> HoverParams -> ShowS # show :: HoverParams -> String # showList :: [HoverParams] -> ShowS # | |
Eq HoverParams | |
Defined in Language.LSP.Types.Hover | |
HasPosition HoverParams Position | |
Defined in Language.LSP.Types.Lens Methods | |
HasTextDocument HoverParams TextDocumentIdentifier | |
Defined in Language.LSP.Types.Lens Methods | |
HasWorkDoneToken HoverParams (Maybe ProgressToken) | |
Defined in Language.LSP.Types.Lens Methods |
data HoverRegistrationOptions #
Constructors
HoverRegistrationOptions | |
Fields |
Instances
data HoverOptions #
Constructors
HoverOptions | |
Fields |
Instances
FromJSON HoverOptions | |
Defined in Language.LSP.Types.Hover | |
ToJSON HoverOptions | |
Defined in Language.LSP.Types.Hover Methods toJSON :: HoverOptions -> Value # toEncoding :: HoverOptions -> Encoding # toJSONList :: [HoverOptions] -> Value # toEncodingList :: [HoverOptions] -> Encoding # | |
Read HoverOptions | |
Defined in Language.LSP.Types.Hover Methods readsPrec :: Int -> ReadS HoverOptions # readList :: ReadS [HoverOptions] # | |
Show HoverOptions | |
Defined in Language.LSP.Types.Hover Methods showsPrec :: Int -> HoverOptions -> ShowS # show :: HoverOptions -> String # showList :: [HoverOptions] -> ShowS # | |
Eq HoverOptions | |
Defined in Language.LSP.Types.Hover | |
HasHoverProvider ServerCapabilities (Maybe (Bool |? HoverOptions)) | |
Defined in Language.LSP.Types.Lens Methods hoverProvider :: Lens' ServerCapabilities (Maybe (Bool |? HoverOptions)) # | |
HasWorkDoneProgress HoverOptions (Maybe Bool) | |
Defined in Language.LSP.Types.Lens Methods |
data HoverClientCapabilities #
Constructors
HoverClientCapabilities | |
Fields |
Instances
data ImplementationParams #
Constructors
ImplementationParams | |
Instances
data ImplementationRegistrationOptions #
Constructors
ImplementationRegistrationOptions | |
Fields |
Instances
data ImplementationOptions #
Constructors
ImplementationOptions | |
Fields |
Instances
data ImplementationClientCapabilities #
Constructors
ImplementationClientCapabilities | |
Fields
|
Instances
data ReferenceParams #
Constructors
ReferenceParams | |
Instances
data ReferenceContext #
Constructors
ReferenceContext | |
Fields
|
Instances
data ReferenceRegistrationOptions #
Constructors
ReferenceRegistrationOptions | |
Fields |
Instances
data ReferenceOptions #
Constructors
ReferenceOptions | |
Fields |
Instances
data ReferencesClientCapabilities #
Constructors
ReferencesClientCapabilities | |
Fields
|
Instances
data RangeWithPlaceholder #
Constructors
RangeWithPlaceholder | |
Fields
|
Instances
FromJSON RangeWithPlaceholder | |
Defined in Language.LSP.Types.Rename Methods parseJSON :: Value -> Parser RangeWithPlaceholder # parseJSONList :: Value -> Parser [RangeWithPlaceholder] # | |
ToJSON RangeWithPlaceholder | |
Defined in Language.LSP.Types.Rename Methods toJSON :: RangeWithPlaceholder -> Value # toEncoding :: RangeWithPlaceholder -> Encoding # toJSONList :: [RangeWithPlaceholder] -> Value # toEncodingList :: [RangeWithPlaceholder] -> Encoding # | |
Eq RangeWithPlaceholder | |
Defined in Language.LSP.Types.Rename Methods (==) :: RangeWithPlaceholder -> RangeWithPlaceholder -> Bool # (/=) :: RangeWithPlaceholder -> RangeWithPlaceholder -> Bool # | |
HasPlaceholder RangeWithPlaceholder Text | |
Defined in Language.LSP.Types.Lens Methods | |
HasRange RangeWithPlaceholder Range | |
Defined in Language.LSP.Types.Lens Methods |
data PrepareRenameParams #
Constructors
PrepareRenameParams | |
Fields |
Instances
data RenameParams #
Constructors
RenameParams | |
Fields |
Instances
FromJSON RenameParams | |
Defined in Language.LSP.Types.Rename | |
ToJSON RenameParams | |
Defined in Language.LSP.Types.Rename Methods toJSON :: RenameParams -> Value # toEncoding :: RenameParams -> Encoding # toJSONList :: [RenameParams] -> Value # toEncodingList :: [RenameParams] -> Encoding # | |
Read RenameParams | |
Defined in Language.LSP.Types.Rename Methods readsPrec :: Int -> ReadS RenameParams # readList :: ReadS [RenameParams] # | |
Show RenameParams | |
Defined in Language.LSP.Types.Rename Methods showsPrec :: Int -> RenameParams -> ShowS # show :: RenameParams -> String # showList :: [RenameParams] -> ShowS # | |
Eq RenameParams | |
Defined in Language.LSP.Types.Rename | |
HasNewName RenameParams Text | |
Defined in Language.LSP.Types.Lens Methods | |
HasPosition RenameParams Position | |
Defined in Language.LSP.Types.Lens Methods | |
HasTextDocument RenameParams TextDocumentIdentifier | |
Defined in Language.LSP.Types.Lens Methods | |
HasWorkDoneToken RenameParams (Maybe ProgressToken) | |
Defined in Language.LSP.Types.Lens Methods |
data RenameRegistrationOptions #
Constructors
RenameRegistrationOptions | |
Fields |
Instances
data RenameOptions #
Constructors
RenameOptions | |
Fields |
Instances
data PrepareSupportDefaultBehavior #
Constructors
PsIdentifier | |
PsUnknown Scientific |
Instances
FromJSON PrepareSupportDefaultBehavior | |
Defined in Language.LSP.Types.Rename Methods parseJSON :: Value -> Parser PrepareSupportDefaultBehavior # parseJSONList :: Value -> Parser [PrepareSupportDefaultBehavior] # | |
ToJSON PrepareSupportDefaultBehavior | |
Defined in Language.LSP.Types.Rename Methods toJSON :: PrepareSupportDefaultBehavior -> Value # toEncoding :: PrepareSupportDefaultBehavior -> Encoding # toJSONList :: [PrepareSupportDefaultBehavior] -> Value # toEncodingList :: [PrepareSupportDefaultBehavior] -> Encoding # | |
Read PrepareSupportDefaultBehavior | |
Show PrepareSupportDefaultBehavior | |
Defined in Language.LSP.Types.Rename Methods showsPrec :: Int -> PrepareSupportDefaultBehavior -> ShowS # show :: PrepareSupportDefaultBehavior -> String # showList :: [PrepareSupportDefaultBehavior] -> ShowS # | |
Eq PrepareSupportDefaultBehavior | |
Defined in Language.LSP.Types.Rename |
data RenameClientCapabilities #
Constructors
RenameClientCapabilities | |
Fields
|
Instances
data SelectionRange #
Constructors
SelectionRange | |
Fields
|
Instances
data SelectionRangeParams #
Constructors
SelectionRangeParams | |
Instances
data SelectionRangeRegistrationOptions #
Constructors
SelectionRangeRegistrationOptions | |
Fields |
Instances
data SelectionRangeOptions #
Constructors
SelectionRangeOptions | |
Fields |
Instances
data SelectionRangeClientCapabilities #
Constructors
SelectionRangeClientCapabilities | |
Fields
|
Instances
makeSemanticTokensDelta :: SemanticTokens -> SemanticTokens -> SemanticTokensDelta #
Convenience function for making a SemanticTokensDelta
from a previous and current SemanticTokens
.
The resulting SemanticTokensDelta
lacks a result ID, which must be set separately if you are using that.
makeSemanticTokens :: SemanticTokensLegend -> [SemanticTokenAbsolute] -> Either Text SemanticTokens #
Convenience method for making a SemanticTokens
from a list of SemanticTokenAbsolute
s. An error may be returned if
computeEdits :: Eq a => [a] -> [a] -> [Edit a] #
Compute a list of edits that will turn the first list into the second list.
encodeTokens :: SemanticTokensLegend -> [SemanticTokenRelative] -> Either Text [UInt] #
Encode a series of relatively-positioned semantic tokens into an integer array following the given legend.
absolutizeTokens :: [SemanticTokenRelative] -> [SemanticTokenAbsolute] #
Turn a list of relatively-positioned tokens into a list of absolutely-positioned tokens. The tokens are assumed to be in the order that they appear in the document!
relativizeTokens :: [SemanticTokenAbsolute] -> [SemanticTokenRelative] #
Turn a list of absolutely-positioned tokens into a list of relatively-positioned tokens. The tokens are assumed to be in the order that they appear in the document!
pattern SemanticTokenAbsolute :: UInt -> UInt -> UInt -> SemanticTokenTypes -> [SemanticTokenModifiers] -> SemanticTokenAbsolute #
pattern SemanticTokenRelative :: UInt -> UInt -> UInt -> SemanticTokenTypes -> [SemanticTokenModifiers] -> SemanticTokenRelative #
An edit to a buffer of items.
Constructors
Edit | |
Fields
|
data SemanticTokensWorkspaceClientCapabilities #
Constructors
SemanticTokensWorkspaceClientCapabilities | |
Fields
|
Instances
data SemanticTokensRangeParams #
Constructors
SemanticTokensRangeParams | |
Instances
data SemanticTokensDeltaPartialResult #
Constructors
SemantictokensDeltaPartialResult | |
Fields |
Instances
data SemanticTokensDelta #
Constructors
SemanticTokensDelta | |
Instances
$sel:_deleteCount:SemanticTokensEdit :: SemanticTokensEdit -> UInt #
The count of elements to remove.
pattern SemanticTokensEdit :: UInt -> UInt -> Maybe (List UInt) -> SemanticTokensEdit #
$sel:_xdata:SemanticTokensEdit :: SemanticTokensEdit -> Maybe (List UInt) #
The elements to insert.
data SemanticTokensDeltaParams #
Constructors
SemanticTokensDeltaParams | |
Instances
data SemanticTokensPartialResult #
Constructors
SemanticTokensPartialResult | |
Instances
FromJSON SemanticTokensPartialResult | |
Defined in Language.LSP.Types.SemanticTokens Methods parseJSON :: Value -> Parser SemanticTokensPartialResult # parseJSONList :: Value -> Parser [SemanticTokensPartialResult] # | |
ToJSON SemanticTokensPartialResult | |
Defined in Language.LSP.Types.SemanticTokens Methods toJSON :: SemanticTokensPartialResult -> Value # toEncoding :: SemanticTokensPartialResult -> Encoding # toJSONList :: [SemanticTokensPartialResult] -> Value # toEncodingList :: [SemanticTokensPartialResult] -> Encoding # | |
HasXdata SemanticTokensPartialResult (List UInt) | |
Defined in Language.LSP.Types.Lens |
data SemanticTokens #
Constructors
SemanticTokens | |
Instances
data SemanticTokensParams #
Constructors
SemanticTokensParams | |
Instances
data SemanticTokensRegistrationOptions #
Constructors
SemanticTokensRegistrationOptions | |
Instances
data SemanticTokensOptions #
Constructors
SemanticTokensOptions | |
Instances
data SemanticTokensClientCapabilities #
Constructors
SemanticTokensClientCapabilities | |
Fields
|
Instances
data SemanticTokensRequestsClientCapabilities #
Constructors
SemanticTokensRequestsClientCapabilities | |
Fields
|
Instances
data SemanticTokensFullClientCapabilities #
Constructors
SemanticTokensFullBool Bool | |
SemanticTokensFullDelta SemanticTokensDeltaClientCapabilities |
Instances
data SemanticTokensDeltaClientCapabilities #
Constructors
SemanticTokensDeltaClientCapabilities | |
Instances
data SemanticTokensRangeClientCapabilities #
Constructors
SemanticTokensRangeBool Bool | |
SemanticTokensRangeObj Value |
Instances
knownSemanticTokenModifiers :: [SemanticTokenModifiers] #
The set of semantic token modifiers which are "known" (i.e. listed in the LSP spec).
knownSemanticTokenTypes :: [SemanticTokenTypes] #
The set of semantic token types which are "known" (i.e. listed in the LSP spec).
data SemanticTokenTypes #
Constructors
Instances
data SemanticTokenModifiers #
Constructors
StmDeclaration | |
StmDefinition | |
StmReadonly | |
StmStatic | |
StmDeprecated | |
StmAbstract | |
StmAsync | |
StmModification | |
StmDocumentation | |
StmDefaultLibrary | |
StmUnknown Text |
Instances
data TokenFormat #
Constructors
TokenFormatRelative |
Instances
FromJSON TokenFormat | |
Defined in Language.LSP.Types.SemanticTokens | |
ToJSON TokenFormat | |
Defined in Language.LSP.Types.SemanticTokens Methods toJSON :: TokenFormat -> Value # toEncoding :: TokenFormat -> Encoding # toJSONList :: [TokenFormat] -> Value # toEncodingList :: [TokenFormat] -> Encoding # | |
Read TokenFormat | |
Defined in Language.LSP.Types.SemanticTokens Methods readsPrec :: Int -> ReadS TokenFormat # readList :: ReadS [TokenFormat] # readPrec :: ReadPrec TokenFormat # readListPrec :: ReadPrec [TokenFormat] # | |
Show TokenFormat | |
Defined in Language.LSP.Types.SemanticTokens Methods showsPrec :: Int -> TokenFormat -> ShowS # show :: TokenFormat -> String # showList :: [TokenFormat] -> ShowS # | |
Eq TokenFormat | |
Defined in Language.LSP.Types.SemanticTokens | |
HasFormats SemanticTokensClientCapabilities (List TokenFormat) | |
Defined in Language.LSP.Types.Lens Methods formats :: Lens' SemanticTokensClientCapabilities (List TokenFormat) # |
data SemanticTokensLegend #
Constructors
SemanticTokensLegend | |
Fields
|
Instances
data SignatureHelpParams #
Constructors
SignatureHelpParams | |
Instances
data SignatureHelpTriggerKind #
How a signature help was triggered.
Since: lsp-types-3.15.0
Constructors
SHTKInvoked | Signature help was invoked manually by the user or by a command. |
SHTKTriggerCharacter | Signature help was triggered by a trigger character. |
SHTKContentChange | Signature help was triggered by the cursor moving or by the document content changing. |
Instances
FromJSON SignatureHelpTriggerKind | |
Defined in Language.LSP.Types.SignatureHelp Methods parseJSON :: Value -> Parser SignatureHelpTriggerKind # parseJSONList :: Value -> Parser [SignatureHelpTriggerKind] # | |
ToJSON SignatureHelpTriggerKind | |
Defined in Language.LSP.Types.SignatureHelp Methods toJSON :: SignatureHelpTriggerKind -> Value # toEncoding :: SignatureHelpTriggerKind -> Encoding # toJSONList :: [SignatureHelpTriggerKind] -> Value # | |
Read SignatureHelpTriggerKind | |
Defined in Language.LSP.Types.SignatureHelp | |
Show SignatureHelpTriggerKind | |
Defined in Language.LSP.Types.SignatureHelp Methods showsPrec :: Int -> SignatureHelpTriggerKind -> ShowS # show :: SignatureHelpTriggerKind -> String # showList :: [SignatureHelpTriggerKind] -> ShowS # | |
Eq SignatureHelpTriggerKind | |
Defined in Language.LSP.Types.SignatureHelp Methods (==) :: SignatureHelpTriggerKind -> SignatureHelpTriggerKind -> Bool # (/=) :: SignatureHelpTriggerKind -> SignatureHelpTriggerKind -> Bool # |
data SignatureHelpContext #
Additional information about the context in which a signature help request was triggered.
Since: lsp-types-3.15.0
Constructors
SignatureHelpContext | |
Fields
|
Instances
data SignatureHelp #
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
Constructors
SignatureHelp | |
Fields
|
Instances
data SignatureInformation #
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
Constructors
SignatureInformation | |
Fields
|
Instances
data ParameterLabel #
Constructors
ParameterLabelString Text | |
ParameterLabelOffset UInt UInt |
Instances
data ParameterInformation #
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
Constructors
ParameterInformation | |
Fields
|
Instances
data SignatureHelpDoc #
Instances
data SignatureHelpRegistrationOptions #
Constructors
SignatureHelpRegistrationOptions | |
Fields |
Instances
data SignatureHelpOptions #
Constructors
SignatureHelpOptions | |
Fields
|
Instances
data SignatureHelpClientCapabilities #
Constructors
SignatureHelpClientCapabilities | |
Fields
|
Instances
data SignatureHelpSignatureInformation #
Constructors
SignatureHelpSignatureInformation | |
Fields
|
Instances
data SignatureHelpParameterInformation #
Constructors
SignatureHelpParameterInformation | |
Fields
|
Instances
data TypeDefinitionParams #
Constructors
TypeDefinitionParams | |
Instances
data TypeDefinitionRegistrationOptions #
Constructors
TypeDefinitionRegistrationOptions | |
Fields |
Instances
data TypeDefinitionOptions #
Constructors
TypeDefinitionOptions | |
Fields |
Instances
data TypeDefinitionClientCapabilities #
Constructors
TypeDefinitionClientCapabilities | |
Fields
|
Instances
data DidCloseTextDocumentParams #
Constructors
DidCloseTextDocumentParams | |
Fields
|
Instances
data DidSaveTextDocumentParams #
Constructors
DidSaveTextDocumentParams | |
Fields
|
Instances
data TextDocumentSaveRegistrationOptions #
Constructors
TextDocumentSaveRegistrationOptions | |
Fields |
Instances
data TextDocumentSaveReason #
Constructors
SaveManual | Manually triggered, e.g. by the user pressing save, by starting debugging, or by an API call. |
SaveAfterDelay | Automatic after a delay |
SaveFocusOut | When the editor lost focus |
Instances
data WillSaveTextDocumentParams #
Constructors
WillSaveTextDocumentParams | |
Fields
|
Instances
data DidChangeTextDocumentParams #
Constructors
DidChangeTextDocumentParams | |
Fields
|
Instances
data TextDocumentContentChangeEvent #
Constructors
TextDocumentContentChangeEvent | |
Instances
data TextDocumentChangeRegistrationOptions #
Constructors
TextDocumentChangeRegistrationOptions | |
Instances
data DidOpenTextDocumentParams #
Constructors
DidOpenTextDocumentParams | |
Fields
|
Instances
data TextDocumentRegistrationOptions #
Constructors
TextDocumentRegistrationOptions | |
Fields |
Instances
data TextDocumentSyncKind #
Defines how the host (editor) should sync document changes to the language server.
Constructors
TdSyncNone | Documents should not be synced at all. |
TdSyncFull | Documents are synced by always sending the full content of the document. |
TdSyncIncremental | Documents are synced by sending the full content on open. After that only incremental updates to the document are send. |
Instances
data TextDocumentSyncOptions #
Constructors
TextDocumentSyncOptions | |
Fields
|
Instances
data SaveOptions #
Constructors
SaveOptions | |
Fields
|
Instances
data TextDocumentSyncClientCapabilities #
Constructors
TextDocumentSyncClientCapabilities | |
Fields
|
Instances
data TextDocumentPositionParams #
Constructors
TextDocumentPositionParams | |
Fields
|
Instances
data TextDocumentItem #
Constructors
TextDocumentItem | |
Instances
data VersionedTextDocumentIdentifier #
Constructors
VersionedTextDocumentIdentifier | |
Fields
|
Instances
type TextDocumentVersion = Maybe Int32 #
data TextDocumentIdentifier #
Constructors
TextDocumentIdentifier | |
Instances
type DocumentSelector = List DocumentFilter #
data DocumentFilter #
Constructors
DocumentFilter | |
Fields
|
Instances
isSubrangeOf :: Range -> Range -> Bool #
isSubrangeOf
returns true if for every Position
in the first Range
, it's also in the second Range
.
mkRange :: UInt -> UInt -> UInt -> UInt -> Range #
A helper function for creating ranges. prop> mkRange l c l' c' = Range (Position l c) (Position l' c')
data LocationLink #
Represents a link between a source and a target location.
Constructors
LocationLink | |
Fields
|
Instances
FromJSON LocationLink | |
Defined in Language.LSP.Types.Location | |
ToJSON LocationLink | |
Defined in Language.LSP.Types.Location Methods toJSON :: LocationLink -> Value # toEncoding :: LocationLink -> Encoding # toJSONList :: [LocationLink] -> Value # toEncodingList :: [LocationLink] -> Encoding # | |
Read LocationLink | |
Defined in Language.LSP.Types.Location Methods readsPrec :: Int -> ReadS LocationLink # readList :: ReadS [LocationLink] # | |
Show LocationLink | |
Defined in Language.LSP.Types.Location Methods showsPrec :: Int -> LocationLink -> ShowS # show :: LocationLink -> String # showList :: [LocationLink] -> ShowS # | |
Eq LocationLink | |
Defined in Language.LSP.Types.Location | |
HasTargetRange LocationLink Range | |
Defined in Language.LSP.Types.Lens Methods | |
HasTargetSelectionRange LocationLink Range | |
Defined in Language.LSP.Types.Lens Methods | |
HasTargetUri LocationLink Uri | |
Defined in Language.LSP.Types.Lens Methods | |
HasOriginSelectionRange LocationLink (Maybe Range) | |
Defined in Language.LSP.Types.Lens Methods |
plainTextToMarkdown :: Text -> Text #
Given some plaintext, convert it into some equivalent markdown text. This is not *quite* the identity function.
Markdown for a section separator in Markdown, being a horizontal line
unmarkedUpContent :: Text -> MarkupContent #
Create a MarkupContent
containing unquoted text
markedUpContent :: Text -> Text -> MarkupContent #
Create a MarkupContent
containing a quoted language string only.
data MarkdownClientCapabilities #
Client capabilities specific to the used markdown parser. @since 3.16.0
Instances
data MarkupKind #
Describes the content type that a client supports in various
result literals like Hover
, ParameterInfo
or CompletionItem
.
Constructors
MkPlainText | Plain text is supported as a content format |
MkMarkdown | Markdown is supported as a content format |
Instances
data MarkupContent #
A MarkupContent
literal represents a string value which content is interpreted base on its
| kind flag. Currently the protocol supports plaintext
and markdown
as markup kinds.
|
| If the kind is markdown
then the value can contain fenced code blocks like in GitHub issues.
| See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
|
| Here is an example how such a string can be constructed using JavaScript / TypeScript:
| ```ts
| let markdown: MarkdownContent = {
| kind: MarkupKind.Markdown,
| value: [
| '# Header',
| 'Some text',
| '``typescript
,
| 'someCode();',
| '```'
| ].join('n')
| };
| ```
|
| *Please Note* that clients might sanitize the return markdown. A client could decide to
| remove HTML from the markdown to avoid script execution.
Constructors
MarkupContent | |
Fields
|
Instances
data LspId (m :: Method f 'Request) #
Id used for a request, Can be either a String or an Int
Instances
FromJSON (LspId m) | |
ToJSON (LspId m) | |
Defined in Language.LSP.Types.LspId | |
Read (LspId m) | |
Show (LspId m) | |
Eq (LspId m) | |
Ord (LspId m) | |
Defined in Language.LSP.Types.LspId | |
Hashable (LspId m) | |
Defined in Language.LSP.Types.LspId | |
IxOrd (LspId :: Method f 'Request -> Type) | |
HasId (ResponseMessage m) (Maybe (LspId m)) | |
Defined in Language.LSP.Types.Lens | |
HasId (RequestMessage m) (LspId m) | |
Defined in Language.LSP.Types.Lens Methods id :: Lens' (RequestMessage m) (LspId m) # | |
type Base (LspId :: Method f 'Request -> Type) | |
Instances
Show SomeLspId | |
Eq SomeLspId | |
Ord SomeLspId | |
Hashable SomeLspId | |
Defined in Language.LSP.Types.LspId |
Constructors
FromServer | |
FromClient |
data MethodType #
Constructors
Notification | |
Request |
data SMethod (m :: Method f t) where #
Constructors
Instances
type SClientMethod (m :: Method 'FromClient t) = SMethod m #
type SServerMethod (m :: Method 'FromServer t) = SMethod m #
data SomeClientMethod #
Constructors
SomeClientMethod (SMethod m) |
Instances
data SomeServerMethod #
Constructors
SomeServerMethod (SMethod m) |
Instances
data SomeMethod where #
Constructors
SomeMethod :: forall {f :: From} {t :: MethodType} (m :: Method f t). SMethod m -> SomeMethod |
Instances
FromJSON SomeMethod | |
Defined in Language.LSP.Types.Method | |
ToJSON SomeMethod | |
Defined in Language.LSP.Types.Method Methods toJSON :: SomeMethod -> Value # toEncoding :: SomeMethod -> Encoding # toJSONList :: [SomeMethod] -> Value # toEncodingList :: [SomeMethod] -> Encoding # | |
Show SomeMethod | |
Defined in Language.LSP.Types.Method Methods showsPrec :: Int -> SomeMethod -> ShowS # show :: SomeMethod -> String # showList :: [SomeMethod] -> ShowS # | |
Eq SomeMethod | |
Defined in Language.LSP.Types.Method | |
Ord SomeMethod | |
Defined in Language.LSP.Types.Method Methods compare :: SomeMethod -> SomeMethod -> Ordering # (<) :: SomeMethod -> SomeMethod -> Bool # (<=) :: SomeMethod -> SomeMethod -> Bool # (>) :: SomeMethod -> SomeMethod -> Bool # (>=) :: SomeMethod -> SomeMethod -> Bool # max :: SomeMethod -> SomeMethod -> SomeMethod # min :: SomeMethod -> SomeMethod -> SomeMethod # |
data PartialResultParams #
Constructors
PartialResultParams | |
Fields
|
Instances
data SomeProgressParams #
Constructors
Begin WorkDoneProgressBeginParams | |
Report WorkDoneProgressReportParams | |
End WorkDoneProgressEndParams |
Instances
FromJSON SomeProgressParams | |
Defined in Language.LSP.Types.Progress Methods parseJSON :: Value -> Parser SomeProgressParams # parseJSONList :: Value -> Parser [SomeProgressParams] # | |
ToJSON SomeProgressParams | |
Defined in Language.LSP.Types.Progress Methods toJSON :: SomeProgressParams -> Value # toEncoding :: SomeProgressParams -> Encoding # toJSONList :: [SomeProgressParams] -> Value # toEncodingList :: [SomeProgressParams] -> Encoding # | |
Eq SomeProgressParams | |
Defined in Language.LSP.Types.Progress Methods (==) :: SomeProgressParams -> SomeProgressParams -> Bool # (/=) :: SomeProgressParams -> SomeProgressParams -> Bool # |
data WorkDoneProgressParams #
Constructors
WorkDoneProgressParams | |
Fields
|
Instances
data WorkDoneProgressOptions #
Constructors
WorkDoneProgressOptions | |
Fields |
Instances
data WorkDoneProgressCreateParams #
Constructors
WorkDoneProgressCreateParams | |
Fields |
Instances
data WorkDoneProgressBeginParams #
Parameters for WorkDoneProgressBeginNotification
.
Since: lsp-types-0.10.0.0
Constructors
WorkDoneProgressBeginParams | |
Fields
|
Instances
data WorkDoneProgressReportParams #
Parameters for WorkDoneProgressReportNotification
Since: lsp-types-0.10.0.0
Constructors
WorkDoneProgressReportParams | |
Fields
|
Instances
data WorkDoneProgressEndParams #
Parameters for WorkDoneProgressEndNotification
.
Since: lsp-types-0.10.0.0
Constructors
WorkDoneProgressEndParams | |
Instances
data WorkDoneProgressCancelParams #
Parameters for WorkDoneProgressCancelNotification
.
Since: lsp-types-0.10.0.0
Constructors
WorkDoneProgressCancelParams | |
Fields
|
Instances
data ProgressParams t #
Parameters for a $/progress notification.
Constructors
ProgressParams | |
Fields
|
Instances
data ProgressToken #
A token used to report progress back or return partial results for a specific request. @since 0.17.0.0
Constructors
ProgressNumericToken Int32 | |
ProgressTextToken Text |
Instances
data StaticRegistrationOptions #
Constructors
StaticRegistrationOptions | |
Instances
emptyNormalizedFilePath :: NormalizedFilePath #
NormalizedFilePath
that contains an empty file path
platformAwareFilePathToUri :: SystemOS -> FilePath -> Uri #
filePathToUri :: FilePath -> Uri #
uriToFilePath :: Uri -> Maybe FilePath #
The "uinteger" type in the LSP spec.
Unusually, this is a **31**-bit unsigned integer, not a 32-bit one.
Instances
A terser, isomorphic data type for Either
, that does not get tagged when
converting to and from JSON.
Instances
Constructors
Empty |
module Language.LSP.Test
module Control.Monad.IO.Class
defaultTestRunner :: TestTree -> IO () Source #
Run defaultMainWithRerun
, limiting each single test case running at most 10 minutes
goldenGitDiff :: TestName -> FilePath -> IO ByteString -> TestTree Source #
goldenWithHaskellDoc :: PluginDescriptor IdeState -> TestName -> FilePath -> FilePath -> FilePath -> FilePath -> (TextDocumentIdentifier -> Session ()) -> TestTree Source #
goldenWithHaskellDocFormatter :: PluginDescriptor IdeState -> String -> PluginConfig -> TestName -> FilePath -> FilePath -> FilePath -> FilePath -> (TextDocumentIdentifier -> Session ()) -> TestTree Source #
runSessionWithServer :: PluginDescriptor IdeState -> FilePath -> Session a -> IO a Source #
runSessionWithServerFormatter :: PluginDescriptor IdeState -> String -> PluginConfig -> FilePath -> Session a -> IO a Source #
runSessionWithServer' Source #
Arguments
:: [PluginDescriptor IdeState] | plugins to load on the server |
-> Config | lsp config for the server |
-> SessionConfig | config for the test session |
-> ClientCapabilities | |
-> FilePath | |
-> Session a | |
-> IO a |
Host a server, and run a test session on it
Note: cwd will be shifted into root
in Session a
waitForProgressDone :: Session () Source #
Wait for the next progress end step
waitForAllProgressDone :: Session () Source #
Wait for all progress to be done Needs at least one progress done notification to return
data PluginDescriptor ideState #
A Shake database plus persistent store. Can be thought of as storing
mappings from (FilePath, k)
to RuleResult k
.
waitForBuildQueue :: Session Seconds Source #
Wait for the build queue to be empty
waitForAction :: String -> TextDocumentIdentifier -> Session (Either ResponseError WaitForIdeRuleResult) Source #
sendConfigurationChanged :: Value -> Session () Source #
waitForKickDone :: Session () Source #
waitForKickStart :: Session () Source #