Safe Haskell	None
Language	Haskell2010

Stack.Setup

Contents

Stack binary download

Synopsis

setupEnv :: (HasBuildConfig env, HasGHCVariant env) => Maybe Text -> RIO env EnvConfig
ensureCompiler :: (HasConfig env, HasGHCVariant env) => SetupOpts -> RIO env (Maybe ExtraDirs, CompilerBuild, Bool)
ensureDockerStackExe :: HasConfig env => Platform -> RIO env (Path Abs File)
getSystemCompiler :: (HasProcessContext env, HasLogFunc env) => WhichCompiler -> RIO env (Maybe (CompilerVersion CVActual, Arch))
getCabalInstallVersion :: (HasProcessContext env, HasLogFunc env) => RIO env (Maybe Version)
data SetupOpts = SetupOpts {
- soptsInstallIfMissing :: !Bool
- soptsUseSystem :: !Bool
- soptsWantedCompiler :: !(CompilerVersion CVWanted)
- soptsCompilerCheck :: !VersionCheck
- soptsStackYaml :: !(Maybe (Path Abs File))
- soptsForceReinstall :: !Bool
- soptsSanityCheck :: !Bool
- soptsSkipGhcCheck :: !Bool
- soptsSkipMsys :: !Bool
- soptsUpgradeCabal :: !(Maybe UpgradeTo)
- soptsResolveMissingGHC :: !(Maybe Text)
- soptsSetupInfoYaml :: !FilePath
- soptsGHCBindistURL :: !(Maybe String)
- soptsGHCJSBootOpts :: [String]
}
defaultSetupInfoYaml :: String
removeHaskellEnvVars :: Map Text Text -> Map Text Text
data StackReleaseInfo
getDownloadVersion :: StackReleaseInfo -> Maybe Version
stackVersion :: Version
preferredPlatforms :: (MonadReader env m, HasPlatform env, MonadThrow m) => m [(Bool, String)]
downloadStackReleaseInfo :: (MonadIO m, MonadThrow m) => Maybe String -> Maybe String -> Maybe String -> m StackReleaseInfo
downloadStackExe :: HasConfig env => [(Bool, String)] -> StackReleaseInfo -> Path Abs Dir -> Bool -> (Path Abs File -> IO ()) -> RIO env ()

Documentation

setupEnv Source #

Arguments

:: (HasBuildConfig env, HasGHCVariant env)
=> Maybe Text	Message to give user when necessary GHC is not available
-> RIO env EnvConfig

Modify the environment variables (like PATH) appropriately, possibly doing installation too

ensureCompiler :: (HasConfig env, HasGHCVariant env) => SetupOpts -> RIO env (Maybe ExtraDirs, CompilerBuild, Bool) Source #

Ensure compiler (ghc or ghcjs) is installed and provide the PATHs to add if necessary

ensureDockerStackExe :: HasConfig env => Platform -> RIO env (Path Abs File) Source #

Ensure Docker container-compatible stack executable is downloaded

getSystemCompiler :: (HasProcessContext env, HasLogFunc env) => WhichCompiler -> RIO env (Maybe (CompilerVersion CVActual, Arch)) Source #

Get the version of the system compiler, if available

getCabalInstallVersion :: (HasProcessContext env, HasLogFunc env) => RIO env (Maybe Version) Source #

data SetupOpts Source #

Constructors

SetupOpts

Fields

soptsInstallIfMissing :: !Bool
soptsUseSystem :: !Bool
Should we use a system compiler installation, if available?
soptsWantedCompiler :: !(CompilerVersion CVWanted)
soptsCompilerCheck :: !VersionCheck
soptsStackYaml :: !(Maybe (Path Abs File))
If we got the desired GHC version from that file
soptsForceReinstall :: !Bool
soptsSanityCheck :: !Bool
Run a sanity check on the selected GHC
soptsSkipGhcCheck :: !Bool
Don't check for a compatible GHC version/architecture
soptsSkipMsys :: !Bool
Do not use a custom msys installation on Windows
soptsUpgradeCabal :: !(Maybe UpgradeTo)
Upgrade the global Cabal library in the database to the newest version. Only works reliably with a stack-managed installation.
soptsResolveMissingGHC :: !(Maybe Text)
Message shown to user for how to resolve the missing GHC
soptsSetupInfoYaml :: !FilePath
Location of the main stack-setup.yaml file
soptsGHCBindistURL :: !(Maybe String)
Alternate GHC binary distribution (requires custom GHCVariant)
soptsGHCJSBootOpts :: [String]
Additional ghcjs-boot options, the default is "--clean"

Instances

Show SetupOpts Source #
Instance details Defined in Stack.Setup Methods showsPrec :: Int -> SetupOpts -> ShowS # show :: SetupOpts -> String # showList :: [SetupOpts] -> ShowS #

defaultSetupInfoYaml :: String Source #

Default location of the stack-setup.yaml file

removeHaskellEnvVars :: Map Text Text -> Map Text Text Source #

Stack binary download

data StackReleaseInfo Source #

getDownloadVersion :: StackReleaseInfo -> Maybe Version Source #

stackVersion :: Version Source #

Current Stack version

preferredPlatforms :: (MonadReader env m, HasPlatform env, MonadThrow m) => m [(Bool, String)] Source #

downloadStackReleaseInfo Source #

Arguments

:: (MonadIO m, MonadThrow m)
=> Maybe String
-> Maybe String
-> Maybe String	optional version
-> m StackReleaseInfo

downloadStackExe Source #

Arguments

:: HasConfig env
=> [(Bool, String)]	acceptable platforms
-> StackReleaseInfo
-> Path Abs Dir	destination directory
-> Bool	perform PATH-aware checking, see #3232
-> (Path Abs File -> IO ())	test the temp exe before renaming
-> RIO env ()