GHCup.HLS

Documentation

data HLSVer

Constructors

SourceDist Version

GitDist GitBranch

HackageDist Version

RemoteDist URI

installHLSBindist

Arguments

:: (MonadMask m, MonadCatch m, MonadReader env m, HasPlatformReq env, HasDirs env, HasSettings env, HasLog env, MonadResource m, MonadIO m, MonadUnliftIO m, MonadFail m)

=> DownloadInfo

-> Version

-> InstallDir

isolated install path, if user passed any

-> Bool

Force install

-> Excepts '[AlreadyInstalled, CopyError, DigestError, GPGError, DownloadFailed, NoDownload, NotInstalled, UnknownArchive, TarDirDoesNotExist, ArchiveResult, FileAlreadyExistsError, ProcessError, DirNotEmpty, UninstallFailed, MergeFileTreeError] m ()

Like 'installHLSBin, except takes the DownloadInfo as argument instead of looking it up from GHCupDownloads.

isLegacyHLSBindist

Arguments

:: FilePath

Path to the unpacked hls bindist

-> IO Bool

installHLSUnpacked

Arguments

:: (MonadMask m, MonadUnliftIO m, MonadReader env m, MonadFail m, HasLog env, HasDirs env, HasSettings env, MonadCatch m, MonadIO m, MonadResource m, HasPlatformReq env)

=> FilePath

Path to the unpacked hls bindist (where the executable resides)

-> InstallDirResolved

Path to install to

-> Version

-> Bool

-> Excepts '[ProcessError, CopyError, FileAlreadyExistsError, NotInstalled, MergeFileTreeError] m ()

Install an unpacked hls distribution.

installHLSUnpackedLegacy

Arguments

:: (MonadReader env m, MonadFail m, HasLog env, MonadCatch m, MonadIO m)

=> FilePath

Path to the unpacked hls bindist (where the executable resides)

-> InstallDirResolved

Path to install to

-> Version

-> Bool

is it a force install

-> Excepts '[CopyError, FileAlreadyExistsError] m ()

Install an unpacked hls distribution (legacy).

installHLSBin :: (MonadMask m, MonadCatch m, MonadReader env m, HasPlatformReq env, HasGHCupInfo env, HasDirs env, HasSettings env, HasLog env, MonadResource m, MonadIO m, MonadUnliftIO m, MonadFail m) => Version -> InstallDir -> Bool -> Excepts '[AlreadyInstalled, CopyError, DigestError, GPGError, DownloadFailed, NoDownload, NotInstalled, UnknownArchive, TarDirDoesNotExist, ArchiveResult, FileAlreadyExistsError, ProcessError, DirNotEmpty, UninstallFailed, MergeFileTreeError] m ()

Installs hls binaries haskell-language-server-<ghcver> into ~/.ghcup/bin/, as well as haskell-languager-server-wrapper.

compileHLS

Arguments

:: (MonadMask m, MonadCatch m, MonadReader env m, HasDirs env, HasSettings env, HasPlatformReq env, HasGHCupInfo env, HasLog env, MonadResource m, MonadIO m, MonadUnliftIO m, MonadFail m)

=> HLSVer

-> [Version]

-> Maybe Int

-> Either Bool Version

-> InstallDir

-> Maybe (Either FilePath URI)

-> Maybe URI

-> Bool

-> Maybe (Either FilePath [URI])

patches

-> [Text]

additional args to cabal install

-> Excepts '[NoDownload, GPGError, DownloadFailed, DigestError, UnknownArchive, TarDirDoesNotExist, ArchiveResult, BuildFailed, NotInstalled] m Version

setHLS :: (MonadReader env m, HasDirs env, HasLog env, MonadIO m, MonadMask m, MonadFail m, MonadUnliftIO m) => Version -> SetHLS -> Maybe FilePath -> Excepts '[NotInstalled] m ()

Set the haskell-language-server symlinks.

unsetHLS :: (MonadMask m, MonadReader env m, HasDirs env, MonadIO m) => m ()

rmHLSVer :: (MonadMask m, MonadReader env m, HasDirs env, MonadThrow m, HasLog env, MonadIO m, MonadFail m, MonadCatch m, MonadUnliftIO m) => Version -> Excepts '[NotInstalled, UninstallFailed] m ()

Delete a hls version. Will try to fix the hls symlinks after removal (e.g. setting it to an older version).

getCabalVersion :: (MonadIO m, MonadFail m) => FilePath -> m Version