Stack.Setup

Documentation

setupEnv

Arguments

:: NeedTargets

-> BuildOptsCLI

-> Maybe Text

Message to give user when necessary GHC is not available

-> RIO BuildConfig EnvConfig

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

ensureCompilerAndMsys :: (HasBuildConfig env, HasGHCVariant env) => SetupOpts -> RIO env (CompilerPaths, ExtraDirs)

Ensure both the compiler and the msys toolchain are installed and provide the PATHs to add if necessary

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

Ensure Docker container-compatible stack executable is downloaded

data SetupOpts

Constructors

SetupOpts

Fields

• soptsInstallIfMissing :: !Bool
• soptsUseSystem :: !Bool

  Should we use a system compiler installation, if available?

• soptsWantedCompiler :: !WantedCompiler
• 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

• soptsResolveMissingGHC :: !(Maybe Text)

  Message shown to user for how to resolve the missing GHC

• soptsGHCBindistURL :: !(Maybe String)

  Alternate GHC binary distribution (requires custom GHCVariant)

Instances

Show SetupOpts

Defined in Stack.Setup

Methods

showsPrec :: Int -> SetupOpts -> ShowS

show :: SetupOpts -> String

showList :: [SetupOpts] -> ShowS

defaultSetupInfoYaml :: String

Default location of the stack-setup.yaml file

withNewLocalBuildTargets :: HasEnvConfig env => [Text] -> RIO env a -> RIO env a

Some commands (script, ghci and exec) set targets dynamically see also the note about only local targets for rebuildEnv

Stack binary download

data StackReleaseInfo

Information on a binary release of Stack

getDownloadVersion :: StackReleaseInfo -> Maybe Version

stackVersion :: Version

Current Stack version

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

downloadStackReleaseInfo

Arguments

:: (HasLogFunc env, HasPlatform env)

=> Maybe String

-> Maybe String

-> Maybe String

optional version

-> RIO env StackReleaseInfo

downloadStackExe

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 ()