Test.Hls.Util

Documentation

codeActionSupportCaps :: ClientCapabilities

expectCodeAction :: [Command |? CodeAction] -> [Text] -> IO ()

expectDiagnostic :: [Diagnostic] -> [Text] -> IO ()

expectNoMoreDiagnostics :: Seconds -> TextDocumentIdentifier -> String -> Session ()

wait for timeout seconds and report an assertion failure if any diagnostic messages arrive in that period

expectSameLocations :: [Location] -> [SymbolLocation] -> Assertion

failIfSessionTimeout :: IO a -> IO a

flushStackEnvironment :: IO ()

fromAction :: (Command |? CodeAction) -> CodeAction

fromCommand :: (Command |? CodeAction) -> Command

getHspecFormattedConfig :: String -> IO Config

ghcVersion :: GhcVersion

data GhcVersion

Constructors

GHC810

GHC88

GHC86

GHC84

Instances

Eq GhcVersion

Defined in Test.Hls.Util

Methods

(==) :: GhcVersion -> GhcVersion -> Bool

(/=) :: GhcVersion -> GhcVersion -> Bool

Show GhcVersion

Defined in Test.Hls.Util

Methods

showsPrec :: Int -> GhcVersion -> ShowS

show :: GhcVersion -> String

showList :: [GhcVersion] -> ShowS

hostOS :: OS

data OS

Constructors

Windows

MacOS

Linux

Instances

Eq OS

Defined in Test.Hls.Util

Methods

(==) :: OS -> OS -> Bool

(/=) :: OS -> OS -> Bool

Show OS

Defined in Test.Hls.Util

Methods

showsPrec :: Int -> OS -> ShowS

show :: OS -> String

showList :: [OS] -> ShowS

matchesCurrentEnv :: EnvSpec -> Bool

data EnvSpec

Constructors

HostOS OS

GhcVer GhcVersion

Instances

Eq EnvSpec

Defined in Test.Hls.Util

Methods

(==) :: EnvSpec -> EnvSpec -> Bool

(/=) :: EnvSpec -> EnvSpec -> Bool

Show EnvSpec

Defined in Test.Hls.Util

Methods

showsPrec :: Int -> EnvSpec -> ShowS

show :: EnvSpec -> String

showList :: [EnvSpec] -> ShowS

ignoreForGhcVersions :: [GhcVersion] -> String -> TestTree -> TestTree

ignoreInEnv :: [EnvSpec] -> String -> TestTree -> TestTree

IgnroeTest if any of environmental spec mathces the current environment.

inspectCodeAction :: [Command |? CodeAction] -> [Text] -> IO CodeAction

inspectCommand :: [Command |? CodeAction] -> [Text] -> IO Command

inspectDiagnostic :: [Diagnostic] -> [Text] -> IO Diagnostic

knownBrokenOnWindows :: String -> TestTree -> TestTree

knownBrokenForGhcVersions :: [GhcVersion] -> String -> TestTree -> TestTree

knownBrokenInEnv :: [EnvSpec] -> String -> TestTree -> TestTree

Mark as broken if any of environmental spec mathces the current environment.

setupBuildToolFiles :: IO ()

type SymbolLocation = (FilePath, Int, Int)

To locate a symbol, we provide a path to the file from the HLS root directory, the line number, and the column number. (0 indexed.)

waitForDiagnosticsFrom :: TextDocumentIdentifier -> Session [Diagnostic]

waitForDiagnosticsFromSource :: TextDocumentIdentifier -> String -> Session [Diagnostic]

waitForDiagnosticsFromSourceWithTimeout :: Seconds -> TextDocumentIdentifier -> String -> Session [Diagnostic]

wait for timeout seconds and return diagnostics for the given document and source. If timeout is 0 it will wait until the session timeout

withCurrentDirectoryInTmp :: FilePath -> IO a -> IO a

Like withCurrentDirectory, but will copy the directory over to the system temporary directory first to avoid haskell-language-server's source tree from interfering with the cradle