GHCup.Utils.Dirs

Documentation

getAllDirs :: IO Dirs

ghcupBaseDir :: IO FilePath

~/.ghcup by default

If GHCUP_USE_XDG_DIRS is set (to anything), then uses 'XDG_DATA_HOME/ghcup' as per xdg spec.

ghcupConfigFile :: MonadIO m => Excepts '[JSONError] m UserSettings

ghcupCacheDir :: IO FilePath

Defaults to '~.ghcupcache'.

If GHCUP_USE_XDG_DIRS is set (to anything), then uses 'XDG_CACHE_HOME/ghcup' as per xdg spec.

ghcupGHCBaseDir :: (MonadReader env m, HasDirs env) => m FilePath

~.ghcupghc by default.

ghcupGHCDir :: (MonadReader env m, HasDirs env, MonadThrow m) => GHCTargetVersion -> m FilePath

Gets '~.ghcupghc/ghcupGHCDir'. The dir may be of the form * armv7-unknown-linux-gnueabihf-8.8.3 * 8.8.4

ghcupHLSBaseDir :: (MonadReader env m, HasDirs env) => m FilePath

~.ghcuphls by default, for new-style installs.

ghcupHLSDir :: (MonadReader env m, HasDirs env, MonadThrow m) => Version -> m FilePath

Gets '~.ghcuphls/hls-ver' for new-style installs.

mkGhcupTmpDir :: (MonadReader env m, HasDirs env, MonadUnliftIO m, HasLog env, MonadCatch m, MonadThrow m, MonadMask m, MonadIO m) => m FilePath

parseGHCupGHCDir :: MonadThrow m => FilePath -> m GHCTargetVersion

See ghcupToolParser.

parseGHCupHLSDir :: MonadThrow m => FilePath -> m Version

relativeSymlink

Arguments

:: FilePath

the path in which to create the symlink

-> FilePath

the symlink destination

-> FilePath

Like relpath. Assumes the inputs are resolved in case of symlinks.

withGHCupTmpDir :: (MonadReader env m, HasDirs env, HasLog env, HasSettings env, MonadUnliftIO m, MonadCatch m, MonadResource m, MonadThrow m, MonadMask m, MonadIO m) => m FilePath

getConfigFilePath :: MonadIO m => m FilePath

useXDG :: IO Bool

cleanupTrash :: (MonadIO m, MonadMask m, MonadReader env m, HasLog env, HasDirs env, HasSettings env) => m ()