| Safe Haskell | Safe-Inferred |
|---|---|
| Language | GHC2021 |
Development.IDE.Test
Synopsis
- type Cursor = (UInt, UInt)
- cursorPosition :: Cursor -> Position
- requireDiagnostic :: (Foldable f, Show (f Diagnostic), HasCallStack) => f Diagnostic -> ExpectedDiagnosticWithTag -> Maybe ErrorMsg
- diagnostic :: Session (TNotificationMessage Method_TextDocumentPublishDiagnostics)
- expectDiagnostics :: HasCallStack => [(FilePath, [ExpectedDiagnostic])] -> Session ()
- expectDiagnosticsWithTags :: HasCallStack => [(String, [ExpectedDiagnosticWithTag])] -> Session ()
- type ExpectedDiagnostic = (DiagnosticSeverity, Cursor, Text, Maybe Text)
- type ExpectedDiagnosticWithTag = (DiagnosticSeverity, Cursor, Text, Maybe Text, Maybe DiagnosticTag)
- expectNoMoreDiagnostics :: HasCallStack => Seconds -> Session ()
- expectMessages :: SMethod m -> Seconds -> (TServerMessage m -> Session ()) -> Session ()
- expectCurrentDiagnostics :: HasCallStack => TextDocumentIdentifier -> [ExpectedDiagnostic] -> Session ()
- checkDiagnosticsForDoc :: HasCallStack => TextDocumentIdentifier -> [ExpectedDiagnostic] -> [Diagnostic] -> Session ()
- canonicalizeUri :: Uri -> IO Uri
- standardizeQuotes :: Text -> Text
- flushMessages :: Session ()
- waitForAction :: String -> TextDocumentIdentifier -> Session WaitForIdeRuleResult
- getInterfaceFilesDir :: TextDocumentIdentifier -> Session FilePath
- garbageCollectDirtyKeys :: CheckParents -> Int -> Session [String]
- getFilesOfInterest :: Session [FilePath]
- waitForTypecheck :: TextDocumentIdentifier -> Session Bool
- waitForBuildQueue :: Session ()
- getStoredKeys :: Session [Text]
- waitForCustomMessage :: Text -> (Value -> Maybe res) -> Session res
- waitForGC :: Session [Text]
- configureCheckProject :: Bool -> Session ()
- isReferenceReady :: FilePath -> Session ()
- referenceReady :: (FilePath -> Bool) -> Session FilePath
Documentation
cursorPosition :: Cursor -> Position Source #
requireDiagnostic :: (Foldable f, Show (f Diagnostic), HasCallStack) => f Diagnostic -> ExpectedDiagnosticWithTag -> Maybe ErrorMsg Source #
diagnostic :: Session (TNotificationMessage Method_TextDocumentPublishDiagnostics) Source #
expectDiagnostics :: HasCallStack => [(FilePath, [ExpectedDiagnostic])] -> Session () Source #
It is not possible to use 'expectDiagnostics []' to assert the absence of diagnostics, only that existing diagnostics have been cleared.
Rather than trying to assert the absence of diagnostics, introduce an expected diagnostic (e.g. a redundant import) and assert the singleton diagnostic.
expectDiagnosticsWithTags :: HasCallStack => [(String, [ExpectedDiagnosticWithTag])] -> Session () Source #
type ExpectedDiagnostic = (DiagnosticSeverity, Cursor, Text, Maybe Text) Source #
Expected diagnostics have the following components:
- severity
- cursor (line and column numbers)
- infix of the message
- code (e.g. GHC-87543)
type ExpectedDiagnosticWithTag = (DiagnosticSeverity, Cursor, Text, Maybe Text, Maybe DiagnosticTag) Source #
Expected diagnostics with a tag have the following components:
- severity
- cursor (line and column numbers)
- infix of the message
- code (e.g. GHC-87543)
- tag (unnecessary or deprecated)
expectNoMoreDiagnostics :: HasCallStack => Seconds -> Session () Source #
wait for timeout seconds and report an assertion failure
if any diagnostic messages arrive in that period
expectCurrentDiagnostics :: HasCallStack => TextDocumentIdentifier -> [ExpectedDiagnostic] -> Session () Source #
checkDiagnosticsForDoc :: HasCallStack => TextDocumentIdentifier -> [ExpectedDiagnostic] -> [Diagnostic] -> Session () Source #
standardizeQuotes :: Text -> Text Source #
flushMessages :: Session () Source #
garbageCollectDirtyKeys :: CheckParents -> Int -> Session [String] Source #
waitForBuildQueue :: Session () Source #
getStoredKeys :: Session [Text] Source #
configureCheckProject :: Bool -> Session () Source #
isReferenceReady :: FilePath -> Session () Source #
Pattern match a message from ghcide indicating that a file has been indexed