Safe Haskell	None
Language	Haskell2010

Stack.Types.Config

Contents

Main configuration types and classes
Details
Paths
Command-specific types

Description

The Config type.

Synopsis

Main configuration types and classes

HasPlatform & HasStackRoot

class HasPlatform env where #

Class for environment values which have a Platform

Methods

getPlatform :: env -> Platform #

getPlatform :: HasConfig env => env -> Platform #

getPlatformVariant :: env -> PlatformVariant #

getPlatformVariant :: HasConfig env => env -> PlatformVariant #

Instances

HasPlatform EnvConfig #
Methods getPlatform :: EnvConfig -> Platform # getPlatformVariant :: EnvConfig -> PlatformVariant #
HasPlatform BuildConfig #
Methods getPlatform :: BuildConfig -> Platform # getPlatformVariant :: BuildConfig -> PlatformVariant #
HasPlatform Config #
Methods getPlatform :: Config -> Platform # getPlatformVariant :: Config -> PlatformVariant #
HasPlatform MiniConfig #
Methods getPlatform :: MiniConfig -> Platform # getPlatformVariant :: MiniConfig -> PlatformVariant #
HasPlatform config => HasPlatform (Env config) #
Methods getPlatform :: Env config -> Platform # getPlatformVariant :: Env config -> PlatformVariant #
HasPlatform (Platform, PlatformVariant) #
Methods getPlatform :: (Platform, PlatformVariant) -> Platform # getPlatformVariant :: (Platform, PlatformVariant) -> PlatformVariant #

class HasStackRoot env where #

Class for environment values which have access to the stack root

Methods

getStackRoot :: env -> Path Abs Dir #

getStackRoot :: HasConfig env => env -> Path Abs Dir #

Instances

HasStackRoot EnvConfig #
Methods getStackRoot :: EnvConfig -> Path Abs Dir #
HasStackRoot BuildConfig #
Methods getStackRoot :: BuildConfig -> Path Abs Dir #
HasStackRoot Config #
Methods getStackRoot :: Config -> Path Abs Dir #
HasStackRoot MiniConfig #
Methods getStackRoot :: MiniConfig -> Path Abs Dir #
HasStackRoot config => HasStackRoot (Env config) #
Methods getStackRoot :: Env config -> Path Abs Dir #

data PlatformVariant #

A variant of the platform, used to differentiate Docker builds from host

Constructors

PlatformVariantNone
PlatformVariant String

Instances

HasPlatform (Platform, PlatformVariant) #
Methods getPlatform :: (Platform, PlatformVariant) -> Platform # getPlatformVariant :: (Platform, PlatformVariant) -> PlatformVariant #

Config & HasConfig

data Config #

The top-level Stackage configuration.

Constructors

Config

Fields

configStackRoot :: !(Path Abs Dir)
~/.stack more often than not
configWorkDir :: !(Path Rel Dir)
this allows to override .stack-work directory
configUserConfigPath :: !(Path Abs File)
Path to user configuration file (usually ~.stackconfig.yaml)
configBuild :: !BuildOpts
Build configuration
configDocker :: !DockerOpts
Docker configuration
configNix :: !NixOpts
Execution environment (e.g nix-shell) configuration
configEnvOverride :: !(EnvSettings -> IO EnvOverride)
Environment variables to be passed to external tools
configLocalProgramsBase :: !(Path Abs Dir)
Non-platform-specific path containing local installations
configLocalPrograms :: !(Path Abs Dir)
Path containing local installations (mainly GHC)
configConnectionCount :: !Int
How many concurrent connections are allowed when downloading
configHideTHLoading :: !Bool
Hide the Template Haskell "Loading package ..." messages from the console
configPlatform :: !Platform
The platform we're building for, used in many directory names
configPlatformVariant :: !PlatformVariant
Variant of the platform, also used in directory names
configGHCVariant0 :: !(Maybe GHCVariant)
The variant of GHC requested by the user. In most cases, use BuildConfig or MiniConfigs version instead, which will have an auto-detected default.
configUrls :: !Urls
URLs for other files used by stack. TODO: Better document e.g. The latest snapshot file. A build plan name (e.g. lts5.9.yaml) is appended when downloading the build plan actually.
configPackageIndices :: ![PackageIndex]
Information on package indices. This is left biased, meaning that packages in an earlier index will shadow those in a later index.
Warning: if you override packages in an index vs what's available upstream, you may correct your compiled snapshots, as different projects may have different definitions of what pkg-ver means! This feature is primarily intended for adding local packages, not overriding. Overriding is better accomplished by adding to your list of packages.
Note that indices specified in a later config file will override previous indices, not extend them.
Using an assoc list instead of a Map to keep track of priority
configSystemGHC :: !Bool
Should we use the system-installed GHC (on the PATH) if available? Can be overridden by command line options.
configInstallGHC :: !Bool
Should we automatically install GHC if missing or the wrong version is available? Can be overridden by command line options.
configSkipGHCCheck :: !Bool
Don't bother checking the GHC version or architecture.
configSkipMsys :: !Bool
On Windows: don't use a locally installed MSYS
configCompilerCheck :: !VersionCheck
Specifies which versions of the compiler are acceptable.
configLocalBin :: !(Path Abs Dir)
Directory we should install executables into
configRequireStackVersion :: !VersionRange
Require a version of stack within this range.
configJobs :: !Int
How many concurrent jobs to run, defaults to number of capabilities
configExtraIncludeDirs :: !(Set Text)
- -extra-include-dirs arguments
configExtraLibDirs :: !(Set Text)
- -extra-lib-dirs arguments
configConcurrentTests :: !Bool
Run test suites concurrently
configImage :: !ImageOpts
configTemplateParams :: !(Map Text Text)
Parameters for templates.
configScmInit :: !(Maybe SCM)
Initialize SCM (e.g. git) when creating new projects.
configGhcOptions :: !GhcOptions
Additional GHC options to apply to either all packages (Nothing) or a specific package (Just).
configSetupInfoLocations :: ![SetupInfoLocation]
Additional SetupInfo (inline or remote) to use to find tools.
configPvpBounds :: !PvpBounds
How PVP upper bounds should be added to packages
configModifyCodePage :: !Bool
Force the code page to UTF-8 on Windows
configExplicitSetupDeps :: !(Map (Maybe PackageName) Bool)
See explicitSetupDeps. Nothing provides the default value.
configRebuildGhcOptions :: !Bool
Rebuild on GHC options changes
configApplyGhcOptions :: !ApplyGhcOptions
Which packages to ghc-options on the command line apply to?
configAllowNewer :: !Bool
Ignore version ranges in .cabal files. Funny naming chosen to match cabal.
configDefaultTemplate :: !(Maybe TemplateName)
The default template to use when none is specified. (If Nothing, the default default is used.)
configAllowDifferentUser :: !Bool
Allow users other than the stack root owner to use the stack installation.
configPackageCaches :: !(IORef (Maybe (Map PackageIdentifier (PackageIndex, PackageCache))))
In memory cache of hackage index.
configMaybeProject :: !(Maybe (Project, Path Abs File))

Instances

HasConfig Config #
Methods getConfig :: Config -> Config #
HasPlatform Config #
Methods getPlatform :: Config -> Platform # getPlatformVariant :: Config -> PlatformVariant #
HasStackRoot Config #
Methods getStackRoot :: Config -> Path Abs Dir #

class (HasStackRoot env, HasPlatform env) => HasConfig env where #

Class for environment values that can provide a Config.

Methods

getConfig :: env -> Config #

getConfig :: HasBuildConfig env => env -> Config #

Instances

HasConfig EnvConfig #
Methods getConfig :: EnvConfig -> Config #
HasConfig BuildConfig #
Methods getConfig :: BuildConfig -> Config #
HasConfig Config #
Methods getConfig :: Config -> Config #
HasConfig MiniConfig #
Methods getConfig :: MiniConfig -> Config #
HasConfig config => HasConfig (Env config) #
Methods getConfig :: Env config -> Config #

askConfig :: (MonadReader env m, HasConfig env) => m Config #

Helper function to ask the environment and apply getConfig

askLatestSnapshotUrl :: (MonadReader env m, HasConfig env) => m Text #

Get the URL to request the information on the latest snapshots

explicitSetupDeps :: (MonadReader env m, HasConfig env) => PackageName -> m Bool #

Provide an explicit list of package dependencies when running a custom Setup.hs

getMinimalEnvOverride :: (MonadReader env m, HasConfig env, MonadIO m) => m EnvOverride #

Get the minimal environment override, useful for just calling external processes like git or ghc

BuildConfig & HasBuildConfig

data BuildConfig #

A superset of Config adding information on how to build code. The reason for this breakdown is because we will need some of the information from Config in order to determine the values here.

Constructors

BuildConfig

Fields

bcConfig :: !Config
bcResolver :: !LoadedResolver
How we resolve which dependencies to install given a set of packages.
bcWantedMiniBuildPlan :: !MiniBuildPlan
Compiler version wanted for this build
bcPackageEntries :: ![PackageEntry]
Local packages
bcExtraDeps :: !(Map PackageName Version)
Extra dependencies specified in configuration.
These dependencies will not be installed to a shared location, and will override packages provided by the resolver.
bcExtraPackageDBs :: ![Path Abs Dir]
Extra package databases
bcStackYaml :: !(Path Abs File)
Location of the stack.yaml file.
Note: if the STACK_YAML environment variable is used, this may be different from bcRoot / "stack.yaml"
bcFlags :: !PackageFlags
Per-package flag overrides
bcImplicitGlobal :: !Bool
Are we loading from the implicit global stack.yaml? This is useful for providing better error messages.
bcGHCVariant :: !GHCVariant
The variant of GHC used to select a GHC bindist.

Instances

HasBuildConfig BuildConfig #
Methods getBuildConfig :: BuildConfig -> BuildConfig #
HasConfig BuildConfig #
Methods getConfig :: BuildConfig -> Config #
HasGHCVariant BuildConfig #
Methods getGHCVariant :: BuildConfig -> GHCVariant #
HasPlatform BuildConfig #
Methods getPlatform :: BuildConfig -> Platform # getPlatformVariant :: BuildConfig -> PlatformVariant #
HasStackRoot BuildConfig #
Methods getStackRoot :: BuildConfig -> Path Abs Dir #

bcRoot :: BuildConfig -> Path Abs Dir #

Directory containing the project's stack.yaml file

bcWorkDir :: (MonadReader env m, HasConfig env) => BuildConfig -> m (Path Abs Dir) #

"bcRoot/.stack-work"

bcWantedCompiler :: BuildConfig -> CompilerVersion #

class HasConfig env => HasBuildConfig env where #

Class for environment values that can provide a BuildConfig.

Minimal complete definition

getBuildConfig

Methods

getBuildConfig :: env -> BuildConfig #

Instances

HasBuildConfig EnvConfig #
Methods getBuildConfig :: EnvConfig -> BuildConfig #
HasBuildConfig BuildConfig #
Methods getBuildConfig :: BuildConfig -> BuildConfig #
HasBuildConfig config => HasBuildConfig (Env config) #
Methods getBuildConfig :: Env config -> BuildConfig #

GHCVariant & HasGHCVariant

data GHCVariant #

Specialized bariant of GHC (e.g. libgmp4 or integer-simple)

Constructors

GHCStandard	Standard bindist
GHCGMP4	Bindist that supports libgmp4 (centos66)
GHCArch	Bindist built on Arch Linux (bleeding-edge)
GHCIntegerSimple	Bindist that uses integer-simple
GHCCustom String	Other bindists

Instances

Show GHCVariant #
Methods showsPrec :: Int -> GHCVariant -> ShowS # show :: GHCVariant -> String # showList :: [GHCVariant] -> ShowS #
FromJSON GHCVariant #
Methods parseJSON :: Value -> Parser GHCVariant
HasGHCVariant GHCVariant #
Methods getGHCVariant :: GHCVariant -> GHCVariant #

ghcVariantName :: GHCVariant -> String #

Render a GHC variant to a String.

ghcVariantSuffix :: GHCVariant -> String #

Render a GHC variant to a String suffix.

parseGHCVariant :: MonadThrow m => String -> m GHCVariant #

Parse GHC variant from a String.

class HasGHCVariant env where #

Class for environment values which have a GHCVariant

Methods

getGHCVariant :: env -> GHCVariant #

getGHCVariant :: HasBuildConfig env => env -> GHCVariant #

Instances

HasGHCVariant GHCVariant #
Methods getGHCVariant :: GHCVariant -> GHCVariant #
HasGHCVariant EnvConfig #
Methods getGHCVariant :: EnvConfig -> GHCVariant #
HasGHCVariant BuildConfig #
Methods getGHCVariant :: BuildConfig -> GHCVariant #
HasGHCVariant MiniConfig #
Methods getGHCVariant :: MiniConfig -> GHCVariant #
HasGHCVariant config => HasGHCVariant (Env config) #
Methods getGHCVariant :: Env config -> GHCVariant #

snapshotsDir :: (MonadReader env m, HasConfig env, HasGHCVariant env, MonadThrow m) => m (Path Abs Dir) #

Directory containing snapshots

EnvConfig & HasEnvConfig

data EnvConfig #

Configuration after the environment has been setup.

Constructors

EnvConfig
Fields envConfigBuildConfig :: !BuildConfig envConfigCabalVersion :: !Version envConfigCompilerVersion :: !CompilerVersion envConfigPackages :: !(Map (Path Abs Dir) TreatLikeExtraDep)

Instances

HasBuildConfig EnvConfig #
Methods getBuildConfig :: EnvConfig -> BuildConfig #
HasConfig EnvConfig #
Methods getConfig :: EnvConfig -> Config #
HasGHCVariant EnvConfig #
Methods getGHCVariant :: EnvConfig -> GHCVariant #
HasPlatform EnvConfig #
Methods getPlatform :: EnvConfig -> Platform # getPlatformVariant :: EnvConfig -> PlatformVariant #
HasStackRoot EnvConfig #
Methods getStackRoot :: EnvConfig -> Path Abs Dir #
HasEnvConfig EnvConfig #
Methods getEnvConfig :: EnvConfig -> EnvConfig #

class (HasBuildConfig r, HasGHCVariant r) => HasEnvConfig r where #

Minimal complete definition

getEnvConfig

Methods

getEnvConfig :: r -> EnvConfig #

Instances

HasEnvConfig EnvConfig #
Methods getEnvConfig :: EnvConfig -> EnvConfig #
HasEnvConfig config => HasEnvConfig (Env config) #
Methods getEnvConfig :: Env config -> EnvConfig #

getWhichCompiler :: (MonadReader env m, HasEnvConfig env) => m WhichCompiler #

getCompilerPath :: (MonadIO m, MonadThrow m, MonadReader env m, HasConfig env) => WhichCompiler -> m (Path Abs File) #

Get the path for the given compiler ignoring any local binaries.

https://github.com/commercialhaskell/stack/issues/1052

Details

ApplyGhcOptions

data ApplyGhcOptions #

Which packages to ghc-options on the command line apply to?

Constructors

AGOTargets	all local targets
AGOLocals	all local packages, even non-targets
AGOEverything	every package

Instances

Bounded ApplyGhcOptions #
Methods minBound :: ApplyGhcOptions # maxBound :: ApplyGhcOptions #
Enum ApplyGhcOptions #
Methods succ :: ApplyGhcOptions -> ApplyGhcOptions # pred :: ApplyGhcOptions -> ApplyGhcOptions # toEnum :: Int -> ApplyGhcOptions # fromEnum :: ApplyGhcOptions -> Int # enumFrom :: ApplyGhcOptions -> [ApplyGhcOptions] # enumFromThen :: ApplyGhcOptions -> ApplyGhcOptions -> [ApplyGhcOptions] # enumFromTo :: ApplyGhcOptions -> ApplyGhcOptions -> [ApplyGhcOptions] # enumFromThenTo :: ApplyGhcOptions -> ApplyGhcOptions -> ApplyGhcOptions -> [ApplyGhcOptions] #
Eq ApplyGhcOptions #
Methods (==) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool # (/=) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool #
Ord ApplyGhcOptions #
Methods compare :: ApplyGhcOptions -> ApplyGhcOptions -> Ordering # (<) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool # (<=) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool # (>) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool # (>=) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool # max :: ApplyGhcOptions -> ApplyGhcOptions -> ApplyGhcOptions # min :: ApplyGhcOptions -> ApplyGhcOptions -> ApplyGhcOptions #
Read ApplyGhcOptions #
Methods readsPrec :: Int -> ReadS ApplyGhcOptions # readList :: ReadS [ApplyGhcOptions] # readPrec :: ReadPrec ApplyGhcOptions # readListPrec :: ReadPrec [ApplyGhcOptions] #
Show ApplyGhcOptions #
Methods showsPrec :: Int -> ApplyGhcOptions -> ShowS # show :: ApplyGhcOptions -> String # showList :: [ApplyGhcOptions] -> ShowS #
FromJSON ApplyGhcOptions #
Methods parseJSON :: Value -> Parser ApplyGhcOptions

ConfigException

data ConfigException #

Constructors

ParseConfigFileException (Path Abs File) ParseException
ParseCustomSnapshotException Text ParseException
ParseResolverException Text
NoProjectConfigFound (Path Abs Dir) (Maybe Text)
UnexpectedArchiveContents [Path Abs Dir] [Path Abs File]
UnableToExtractArchive Text (Path Abs File)
BadStackVersionException VersionRange
NoMatchingSnapshot WhichSolverCmd (NonEmpty SnapName)
ResolverMismatch WhichSolverCmd (ResolverThat's l) String
ResolverPartial WhichSolverCmd Resolver String
NoSuchDirectory FilePath
ParseGHCVariantException String
BadStackRoot (Path Abs Dir)
Won'tCreateStackRootInDirectoryOwnedByDifferentUser (Path Abs Dir) (Path Abs Dir)	`$STACK_ROOT`, parent dir
UserDoesn'tOwnDirectory (Path Abs Dir)

Instances

Show ConfigException #
Methods showsPrec :: Int -> ConfigException -> ShowS # show :: ConfigException -> String # showList :: [ConfigException] -> ShowS #
Exception ConfigException #
Methods toException :: ConfigException -> SomeException # fromException :: SomeException -> Maybe ConfigException # displayException :: ConfigException -> String #

WhichSolverCmd

data WhichSolverCmd #

Constructors

IsInitCmd
IsSolverCmd
IsNewCmd

ConfigMonoid

data ConfigMonoid #

Constructors

ConfigMonoid

Fields

configMonoidStackRoot :: !(First (Path Abs Dir))
See: configStackRoot
configMonoidWorkDir :: !(First FilePath)
See: configWorkDir.
configMonoidBuildOpts :: !BuildOptsMonoid
build options.
configMonoidDockerOpts :: !DockerOptsMonoid
Docker options.
configMonoidNixOpts :: !NixOptsMonoid
Options for the execution environment (nix-shell or container)
configMonoidConnectionCount :: !(First Int)
See: configConnectionCount
configMonoidHideTHLoading :: !(First Bool)
See: configHideTHLoading
configMonoidLatestSnapshotUrl :: !(First Text)
Deprecated in favour of urlsMonoidLatestSnapshot
configMonoidUrls :: !UrlsMonoid
See: 'configUrls
configMonoidPackageIndices :: !(First [PackageIndex])
See: configPackageIndices
configMonoidSystemGHC :: !(First Bool)
See: configSystemGHC
configMonoidInstallGHC :: !(First Bool)
See: configInstallGHC
configMonoidSkipGHCCheck :: !(First Bool)
See: configSkipGHCCheck
configMonoidSkipMsys :: !(First Bool)
See: configSkipMsys
configMonoidCompilerCheck :: !(First VersionCheck)
See: configCompilerCheck
configMonoidRequireStackVersion :: !IntersectingVersionRange
See: configRequireStackVersion
configMonoidOS :: !(First String)
Used for overriding the platform
configMonoidArch :: !(First String)
Used for overriding the platform
configMonoidGHCVariant :: !(First GHCVariant)
Used for overriding the GHC variant
configMonoidJobs :: !(First Int)
See: configJobs
configMonoidExtraIncludeDirs :: !(Set Text)
See: configExtraIncludeDirs
configMonoidExtraLibDirs :: !(Set Text)
See: configExtraLibDirs
configMonoidConcurrentTests :: !(First Bool)
See: configConcurrentTests
configMonoidLocalBinPath :: !(First FilePath)
Used to override the binary installation dir
configMonoidImageOpts :: !ImageOptsMonoid
Image creation options.
configMonoidTemplateParameters :: !(Map Text Text)
Template parameters.
configMonoidScmInit :: !(First SCM)
Initialize SCM (e.g. git init) when making new projects?
configMonoidGhcOptions :: !GhcOptions
See configGhcOptions
configMonoidExtraPath :: ![Path Abs Dir]
Additional paths to search for executables in
configMonoidSetupInfoLocations :: ![SetupInfoLocation]
Additional setup info (inline or remote) to use for installing tools
configMonoidPvpBounds :: !(First PvpBounds)
See configPvpBounds
configMonoidModifyCodePage :: !(First Bool)
See configModifyCodePage
configMonoidExplicitSetupDeps :: !(Map (Maybe PackageName) Bool)
See configExplicitSetupDeps
configMonoidRebuildGhcOptions :: !(First Bool)
See configMonoidRebuildGhcOptions
configMonoidApplyGhcOptions :: !(First ApplyGhcOptions)
See configApplyGhcOptions
configMonoidAllowNewer :: !(First Bool)
See configMonoidAllowNewer
configMonoidDefaultTemplate :: !(First TemplateName)
The default template to use when none is specified. (If Nothing, the default default is used.)
configMonoidAllowDifferentUser :: !(First Bool)
Allow users other than the stack root owner to use the stack installation.

Instances

Show ConfigMonoid #
Methods showsPrec :: Int -> ConfigMonoid -> ShowS # show :: ConfigMonoid -> String # showList :: [ConfigMonoid] -> ShowS #
Generic ConfigMonoid #
Associated Types type Rep ConfigMonoid :: * -> * # Methods from :: ConfigMonoid -> Rep ConfigMonoid x # to :: Rep ConfigMonoid x -> ConfigMonoid #
Monoid ConfigMonoid #
Methods mempty :: ConfigMonoid # mappend :: ConfigMonoid -> ConfigMonoid -> ConfigMonoid # mconcat :: [ConfigMonoid] -> ConfigMonoid #
FromJSON (WithJSONWarnings ConfigMonoid) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings ConfigMonoid)
type Rep ConfigMonoid #
type Rep ConfigMonoid = D1 (MetaData "ConfigMonoid" "Stack.Types.Config" "stack-1.1.2-49dhs7u8deFCRPHWDHyZQB" False) (C1 (MetaCons "ConfigMonoid" PrefixI True) ((::) ((::) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidStackRoot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (Path Abs Dir)))) (S1 (MetaSel (Just Symbol "configMonoidWorkDir") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath)))) ((::) (S1 (MetaSel (Just Symbol "configMonoidBuildOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BuildOptsMonoid)) (S1 (MetaSel (Just Symbol "configMonoidDockerOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DockerOptsMonoid)))) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidNixOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NixOptsMonoid)) (S1 (MetaSel (Just Symbol "configMonoidConnectionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Int)))) ((::) (S1 (MetaSel (Just Symbol "configMonoidHideTHLoading") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) ((::) (S1 (MetaSel (Just Symbol "configMonoidLatestSnapshotUrl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Text))) (S1 (MetaSel (Just Symbol "configMonoidUrls") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UrlsMonoid)))))) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidPackageIndices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First [PackageIndex]))) (S1 (MetaSel (Just Symbol "configMonoidSystemGHC") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) ((::) (S1 (MetaSel (Just Symbol "configMonoidInstallGHC") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) ((::) (S1 (MetaSel (Just Symbol "configMonoidSkipGHCCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) (S1 (MetaSel (Just Symbol "configMonoidSkipMsys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))))) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidCompilerCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First VersionCheck))) (S1 (MetaSel (Just Symbol "configMonoidRequireStackVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IntersectingVersionRange))) ((::) (S1 (MetaSel (Just Symbol "configMonoidOS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String))) ((::) (S1 (MetaSel (Just Symbol "configMonoidArch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String))) (S1 (MetaSel (Just Symbol "configMonoidGHCVariant") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First GHCVariant)))))))) ((::) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Int))) (S1 (MetaSel (Just Symbol "configMonoidExtraIncludeDirs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Set Text)))) ((::) (S1 (MetaSel (Just Symbol "configMonoidExtraLibDirs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Set Text))) (S1 (MetaSel (Just Symbol "configMonoidConcurrentTests") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))))) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidLocalBinPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath))) (S1 (MetaSel (Just Symbol "configMonoidImageOpts") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 ImageOptsMonoid))) ((::) (S1 (MetaSel (Just Symbol "configMonoidTemplateParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map Text Text))) ((::) (S1 (MetaSel (Just Symbol "configMonoidScmInit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First SCM))) (S1 (MetaSel (Just Symbol "configMonoidGhcOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GhcOptions)))))) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidExtraPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Path Abs Dir])) (S1 (MetaSel (Just Symbol "configMonoidSetupInfoLocations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [SetupInfoLocation]))) ((::) (S1 (MetaSel (Just Symbol "configMonoidPvpBounds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First PvpBounds))) ((::) (S1 (MetaSel (Just Symbol "configMonoidModifyCodePage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) (S1 (MetaSel (Just Symbol "configMonoidExplicitSetupDeps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map (Maybe PackageName) Bool)))))) ((::) ((::) (S1 (MetaSel (Just Symbol "configMonoidRebuildGhcOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) (S1 (MetaSel (Just Symbol "configMonoidApplyGhcOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First ApplyGhcOptions)))) ((::) (S1 (MetaSel (Just Symbol "configMonoidAllowNewer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) ((:*:) (S1 (MetaSel (Just Symbol "configMonoidDefaultTemplate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First TemplateName))) (S1 (MetaSel (Just Symbol "configMonoidAllowDifferentUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))))))))))

EnvSettings

data EnvSettings #

Controls which version of the environment is used

Constructors

EnvSettings
Fields esIncludeLocals :: !Bool include local project bin directory, GHC_PACKAGE_PATH, etc esIncludeGhcPackagePath :: !Bool include the GHC_PACKAGE_PATH variable esStackExe :: !Bool set the STACK_EXE variable to the current executable name esLocaleUtf8 :: !Bool set the locale to C.UTF-8

Instances

Eq EnvSettings #
Methods (==) :: EnvSettings -> EnvSettings -> Bool # (/=) :: EnvSettings -> EnvSettings -> Bool #
Ord EnvSettings #
Methods compare :: EnvSettings -> EnvSettings -> Ordering # (<) :: EnvSettings -> EnvSettings -> Bool # (<=) :: EnvSettings -> EnvSettings -> Bool # (>) :: EnvSettings -> EnvSettings -> Bool # (>=) :: EnvSettings -> EnvSettings -> Bool # max :: EnvSettings -> EnvSettings -> EnvSettings # min :: EnvSettings -> EnvSettings -> EnvSettings #
Show EnvSettings #
Methods showsPrec :: Int -> EnvSettings -> ShowS # show :: EnvSettings -> String # showList :: [EnvSettings] -> ShowS #

minimalEnvSettings :: EnvSettings #

GlobalOpts & GlobalOptsMonoid

data GlobalOpts #

Parsed global command-line options.

Constructors

GlobalOpts

Fields

globalReExecVersion :: !(Maybe String)
Expected re-exec in container version
globalDockerEntrypoint :: !(Maybe DockerEntrypoint)
Data used when stack is acting as a Docker entrypoint (internal use only)
globalLogLevel :: !LogLevel
Log level
globalConfigMonoid :: !ConfigMonoid
Config monoid, for passing into loadConfig
globalResolver :: !(Maybe AbstractResolver)
Resolver override
globalCompiler :: !(Maybe CompilerVersion)
Compiler override
globalTerminal :: !Bool
We're in a terminal?
globalStackYaml :: !(Maybe FilePath)
Override project stack.yaml

Instances

Show GlobalOpts #
Methods showsPrec :: Int -> GlobalOpts -> ShowS # show :: GlobalOpts -> String # showList :: [GlobalOpts] -> ShowS #

data GlobalOptsMonoid #

Parsed global command-line options monoid.

Constructors

GlobalOptsMonoid

Fields

globalMonoidReExecVersion :: !(First String)
Expected re-exec in container version
globalMonoidDockerEntrypoint :: !(First DockerEntrypoint)
Data used when stack is acting as a Docker entrypoint (internal use only)
globalMonoidLogLevel :: !(First LogLevel)
Log level
globalMonoidConfigMonoid :: !ConfigMonoid
Config monoid, for passing into loadConfig
globalMonoidResolver :: !(First AbstractResolver)
Resolver override
globalMonoidCompiler :: !(First CompilerVersion)
Compiler override
globalMonoidTerminal :: !(First Bool)
We're in a terminal?
globalMonoidStackYaml :: !(First FilePath)
Override project stack.yaml

Instances

Show GlobalOptsMonoid #
Methods showsPrec :: Int -> GlobalOptsMonoid -> ShowS # show :: GlobalOptsMonoid -> String # showList :: [GlobalOptsMonoid] -> ShowS #
Generic GlobalOptsMonoid #
Associated Types type Rep GlobalOptsMonoid :: * -> * # Methods from :: GlobalOptsMonoid -> Rep GlobalOptsMonoid x # to :: Rep GlobalOptsMonoid x -> GlobalOptsMonoid #
Monoid GlobalOptsMonoid #
Methods mempty :: GlobalOptsMonoid # mappend :: GlobalOptsMonoid -> GlobalOptsMonoid -> GlobalOptsMonoid # mconcat :: [GlobalOptsMonoid] -> GlobalOptsMonoid #
type Rep GlobalOptsMonoid #
type Rep GlobalOptsMonoid = D1 (MetaData "GlobalOptsMonoid" "Stack.Types.Config" "stack-1.1.2-49dhs7u8deFCRPHWDHyZQB" False) (C1 (MetaCons "GlobalOptsMonoid" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "globalMonoidReExecVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String))) (S1 (MetaSel (Just Symbol "globalMonoidDockerEntrypoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First DockerEntrypoint)))) ((::) (S1 (MetaSel (Just Symbol "globalMonoidLogLevel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First LogLevel))) (S1 (MetaSel (Just Symbol "globalMonoidConfigMonoid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ConfigMonoid)))) ((::) ((::) (S1 (MetaSel (Just Symbol "globalMonoidResolver") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First AbstractResolver))) (S1 (MetaSel (Just Symbol "globalMonoidCompiler") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First CompilerVersion)))) ((:*:) (S1 (MetaSel (Just Symbol "globalMonoidTerminal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) (S1 (MetaSel (Just Symbol "globalMonoidStackYaml") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath)))))))

defaultLogLevel :: LogLevel #

Default logging level should be something useful but not crazy.

LoadConfig

data LoadConfig m #

Value returned by loadConfig.

Constructors

LoadConfig
Fields lcConfig :: !Config Top-level Stack configuration. lcLoadBuildConfig :: !(Maybe CompilerVersion -> m BuildConfig) Action to load the remaining `BuildConfig`. lcProjectRoot :: !(Maybe (Path Abs Dir)) The project root directory, if in a project.

PackageEntry & PackageLocation

data PackageEntry #

Constructors

PackageEntry
Fields peExtraDep :: !TreatLikeExtraDep peLocation :: !PackageLocation peSubdirs :: ![FilePath]

Instances

Show PackageEntry #
Methods showsPrec :: Int -> PackageEntry -> ShowS # show :: PackageEntry -> String # showList :: [PackageEntry] -> ShowS #
ToJSON PackageEntry #
Methods toJSON :: PackageEntry -> Value toEncoding :: PackageEntry -> Encoding
FromJSON (WithJSONWarnings PackageEntry) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings PackageEntry)

type TreatLikeExtraDep = Bool #

Should a package be treated just like an extra-dep?

True means, it will only be built as a dependency for others, and its test suite/benchmarks will not be run.

Useful modifying an upstream package, see: https://github.com/commercialhaskell/stack/issues/219 https://github.com/commercialhaskell/stack/issues/386

data PackageLocation #

Constructors

PLFilePath FilePath	Note that we use `FilePath` and not `Path`s. The goal is: first parse the value raw, and then use `canonicalizePath` and `parseAbsDir`.
PLRemote Text RemotePackageType	URL and further details

Instances

Show PackageLocation #
Methods showsPrec :: Int -> PackageLocation -> ShowS # show :: PackageLocation -> String # showList :: [PackageLocation] -> ShowS #
ToJSON PackageLocation #
Methods toJSON :: PackageLocation -> Value toEncoding :: PackageLocation -> Encoding
FromJSON (WithJSONWarnings PackageLocation) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings PackageLocation)

data RemotePackageType #

Constructors

RPTHttp
RPTGit Text	Commit
RPTHg Text	Commit

Instances

Show RemotePackageType #
Methods showsPrec :: Int -> RemotePackageType -> ShowS # show :: RemotePackageType -> String # showList :: [RemotePackageType] -> ShowS #

PackageIndex, IndexName & IndexLocation

data PackageIndex #

Information on a single package index

Constructors

PackageIndex
Fields indexName :: !IndexName indexLocation :: !IndexLocation indexDownloadPrefix :: !Text URL prefix for downloading packages indexGpgVerify :: !Bool GPG-verify the package index during download. Only applies to Git repositories for now. indexRequireHashes :: !Bool Require that hashes and package size information be available for packages in this index

Instances

Show PackageIndex #
Methods showsPrec :: Int -> PackageIndex -> ShowS # show :: PackageIndex -> String # showList :: [PackageIndex] -> ShowS #
FromJSON (WithJSONWarnings PackageIndex) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings PackageIndex)

newtype IndexName #

Unique name for a package index

Constructors

IndexName
Fields unIndexName :: ByteString

Instances

Eq IndexName #
Methods (==) :: IndexName -> IndexName -> Bool # (/=) :: IndexName -> IndexName -> Bool #
Ord IndexName #
Methods compare :: IndexName -> IndexName -> Ordering # (<) :: IndexName -> IndexName -> Bool # (<=) :: IndexName -> IndexName -> Bool # (>) :: IndexName -> IndexName -> Bool # (>=) :: IndexName -> IndexName -> Bool # max :: IndexName -> IndexName -> IndexName # min :: IndexName -> IndexName -> IndexName #
Show IndexName #
Methods showsPrec :: Int -> IndexName -> ShowS # show :: IndexName -> String # showList :: [IndexName] -> ShowS #
Binary IndexName #
Methods put :: IndexName -> Put # get :: Get IndexName # putList :: [IndexName] -> Put #
Hashable IndexName #
Methods hashWithSalt :: Int -> IndexName -> Int # hash :: IndexName -> Int #
FromJSON IndexName #
Methods parseJSON :: Value -> Parser IndexName
ToJSON IndexName #
Methods toJSON :: IndexName -> Value toEncoding :: IndexName -> Encoding

configPackageIndex :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs File) #

Location of the 00-index.tar file

configPackageIndexCache :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs File) #

Location of the 00-index.cache file

configPackageIndexGz :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs File) #

Location of the 00-index.tar.gz file

configPackageIndexRoot :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs Dir) #

Root for a specific package index

configPackageIndexRepo :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Maybe (Path Abs Dir)) #

Git repo directory for a specific package index, returns Nothing if not a Git repo

configPackageTarball :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> PackageIdentifier -> m (Path Abs File) #

Location of a package tarball

indexNameText :: IndexName -> Text #

data IndexLocation #

Location of the package index. This ensures that at least one of Git or HTTP is available.

Constructors

ILGit !Text
ILHttp !Text
ILGitHttp !Text !Text

Instances

Eq IndexLocation #
Methods (==) :: IndexLocation -> IndexLocation -> Bool # (/=) :: IndexLocation -> IndexLocation -> Bool #
Ord IndexLocation #
Methods compare :: IndexLocation -> IndexLocation -> Ordering # (<) :: IndexLocation -> IndexLocation -> Bool # (<=) :: IndexLocation -> IndexLocation -> Bool # (>) :: IndexLocation -> IndexLocation -> Bool # (>=) :: IndexLocation -> IndexLocation -> Bool # max :: IndexLocation -> IndexLocation -> IndexLocation # min :: IndexLocation -> IndexLocation -> IndexLocation #
Show IndexLocation #
Methods showsPrec :: Int -> IndexLocation -> ShowS # show :: IndexLocation -> String # showList :: [IndexLocation] -> ShowS #

Project & ProjectAndConfigMonoid

data Project #

A project is a collection of packages. We can have multiple stack.yaml files, but only one of them may contain project information.

Constructors

Project

Fields

projectUserMsg :: !(Maybe String)
A warning message to display to the user when the auto generated config may have issues.
projectPackages :: ![PackageEntry]
Components of the package list
projectExtraDeps :: !(Map PackageName Version)
Components of the package list referring to package/version combos, see: https://github.com/fpco/stack/issues/41
projectFlags :: !PackageFlags
Per-package flag overrides
projectResolver :: !Resolver
How we resolve which dependencies to use
projectCompiler :: !(Maybe CompilerVersion)
When specified, overrides which compiler to use
projectExtraPackageDBs :: ![FilePath]

Instances

Show Project #
Methods showsPrec :: Int -> Project -> ShowS # show :: Project -> String # showList :: [Project] -> ShowS #
ToJSON Project #
Methods toJSON :: Project -> Value toEncoding :: Project -> Encoding

data ProjectAndConfigMonoid #

Constructors

ProjectAndConfigMonoid !Project !ConfigMonoid

Instances

FromJSON (WithJSONWarnings ProjectAndConfigMonoid) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings ProjectAndConfigMonoid)

PvpBounds

data PvpBounds #

How PVP bounds should be added to .cabal files

Constructors

PvpBoundsNone
PvpBoundsUpper
PvpBoundsLower
PvpBoundsBoth

Instances

Bounded PvpBounds #
Methods minBound :: PvpBounds # maxBound :: PvpBounds #
Enum PvpBounds #
Methods succ :: PvpBounds -> PvpBounds # pred :: PvpBounds -> PvpBounds # toEnum :: Int -> PvpBounds # fromEnum :: PvpBounds -> Int # enumFrom :: PvpBounds -> [PvpBounds] # enumFromThen :: PvpBounds -> PvpBounds -> [PvpBounds] # enumFromTo :: PvpBounds -> PvpBounds -> [PvpBounds] # enumFromThenTo :: PvpBounds -> PvpBounds -> PvpBounds -> [PvpBounds] #
Eq PvpBounds #
Methods (==) :: PvpBounds -> PvpBounds -> Bool # (/=) :: PvpBounds -> PvpBounds -> Bool #
Ord PvpBounds #
Methods compare :: PvpBounds -> PvpBounds -> Ordering # (<) :: PvpBounds -> PvpBounds -> Bool # (<=) :: PvpBounds -> PvpBounds -> Bool # (>) :: PvpBounds -> PvpBounds -> Bool # (>=) :: PvpBounds -> PvpBounds -> Bool # max :: PvpBounds -> PvpBounds -> PvpBounds # min :: PvpBounds -> PvpBounds -> PvpBounds #
Read PvpBounds #
Methods readsPrec :: Int -> ReadS PvpBounds # readList :: ReadS [PvpBounds] # readPrec :: ReadPrec PvpBounds # readListPrec :: ReadPrec [PvpBounds] #
Show PvpBounds #
Methods showsPrec :: Int -> PvpBounds -> ShowS # show :: PvpBounds -> String # showList :: [PvpBounds] -> ShowS #
FromJSON PvpBounds #
Methods parseJSON :: Value -> Parser PvpBounds
ToJSON PvpBounds #
Methods toJSON :: PvpBounds -> Value toEncoding :: PvpBounds -> Encoding

parsePvpBounds :: Text -> Either String PvpBounds #

Resolver & AbstractResolver

type Resolver = ResolverThat's NotLoaded #

type LoadedResolver = ResolverThat's Loaded #

data ResolverThat's l where #

How we resolve which dependencies to install given a set of packages.

Constructors

ResolverSnapshot :: !SnapName -> ResolverThat's l
ResolverCompiler :: !CompilerVersion -> ResolverThat's l
ResolverCustom :: !Text -> !Text -> ResolverThat's NotLoaded
ResolverCustomLoaded :: !Text -> !Text -> !SnapshotHash -> ResolverThat's Loaded

Instances

Show (ResolverThat's k) #
Methods showsPrec :: Int -> ResolverThat's k -> ShowS # show :: ResolverThat's k -> String # showList :: [ResolverThat's k] -> ShowS #
FromJSON (WithJSONWarnings (CustomSnapshot, Maybe Resolver)) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings (CustomSnapshot, Maybe Resolver))
ToJSON (ResolverThat's k) #
Methods toJSON :: ResolverThat's k -> Value toEncoding :: ResolverThat's k -> Encoding

parseResolverText :: MonadThrow m => Text -> m Resolver #

Try to parse a Resolver from a Text. Won't work for complex resolvers (like custom).

resolverDirName :: LoadedResolver -> Text #

Convert a Resolver into its Text representation, as will be used by directory names

resolverName :: ResolverThat's l -> Text #

Convert a Resolver into its Text representation for human presentation.

customResolverHash :: LoadedResolver -> Maybe SnapshotHash #

toResolverNotLoaded :: LoadedResolver -> Resolver #

data AbstractResolver #

Either an actual resolver value, or an abstract description of one (e.g., latest nightly).

Constructors

ARLatestNightly
ARLatestLTS
ARLatestLTSMajor !Int
ARResolver !Resolver
ARGlobal

Instances

Show AbstractResolver #
Methods showsPrec :: Int -> AbstractResolver -> ShowS # show :: AbstractResolver -> String # showList :: [AbstractResolver] -> ShowS #

SCM

data SCM #

A software control system.

Constructors

Git

Instances

Show SCM #
Methods showsPrec :: Int -> SCM -> ShowS # show :: SCM -> String # showList :: [SCM] -> ShowS #
FromJSON SCM #
Methods parseJSON :: Value -> Parser SCM
ToJSON SCM #
Methods toJSON :: SCM -> Value toEncoding :: SCM -> Encoding

CustomSnapshot

data CustomSnapshot #

Constructors

CustomSnapshot
Fields csCompilerVersion :: !(Maybe CompilerVersion) csPackages :: !(Set PackageIdentifier) csDropPackages :: !(Set PackageName) csFlags :: !PackageFlags csGhcOptions :: !GhcOptions

Instances

FromJSON (WithJSONWarnings (CustomSnapshot, Maybe Resolver)) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings (CustomSnapshot, Maybe Resolver))

GhcOptions

newtype GhcOptions #

Constructors

GhcOptions
Fields unGhcOptions :: Map (Maybe PackageName) [Text]

Instances

Show GhcOptions #
Methods showsPrec :: Int -> GhcOptions -> ShowS # show :: GhcOptions -> String # showList :: [GhcOptions] -> ShowS #
Monoid GhcOptions #
Methods mempty :: GhcOptions # mappend :: GhcOptions -> GhcOptions -> GhcOptions # mconcat :: [GhcOptions] -> GhcOptions #
FromJSON GhcOptions #
Methods parseJSON :: Value -> Parser GhcOptions

ghcOptionsFor :: PackageName -> GhcOptions -> [Text] #

PackageFlags

newtype PackageFlags #

Constructors

PackageFlags
Fields unPackageFlags :: Map PackageName (Map FlagName Bool)

Instances

Show PackageFlags #
Methods showsPrec :: Int -> PackageFlags -> ShowS # show :: PackageFlags -> String # showList :: [PackageFlags] -> ShowS #
Monoid PackageFlags #
Methods mempty :: PackageFlags # mappend :: PackageFlags -> PackageFlags -> PackageFlags # mconcat :: [PackageFlags] -> PackageFlags #
FromJSON PackageFlags #
Methods parseJSON :: Value -> Parser PackageFlags
ToJSON PackageFlags #
Methods toJSON :: PackageFlags -> Value toEncoding :: PackageFlags -> Encoding

Paths

bindirSuffix :: Path Rel Dir #

Suffix applied to an installation root to get the bin dir

configInstalledCache :: (HasBuildConfig env, MonadReader env m) => m (Path Abs File) #

File containing the installed cache, see Stack.PackageDump

configMiniBuildPlanCache :: (MonadThrow m, MonadReader env m, HasConfig env, HasGHCVariant env) => SnapName -> m (Path Abs File) #

Where to store mini build plan caches

getProjectWorkDir :: (HasBuildConfig env, MonadReader env m) => m (Path Abs Dir) #

Per-project work dir

docDirSuffix :: Path Rel Dir #

Suffix applied to an installation root to get the doc dir

flagCacheLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) #

Directory for holding flag cache information

extraBinDirs :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Bool -> [Path Abs Dir]) #

Get the extra bin directories (for the PATH). Puts more local first

Bool indicates whether or not to include the locals

hpcReportDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) #

Where HPC reports and tix files get stored.

installationRootDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) #

Installation root for dependencies

installationRootLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) #

Installation root for locals

packageDatabaseDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) #

Package database for installing dependencies into

packageDatabaseExtra :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m [Path Abs Dir] #

Extra package databases

packageDatabaseLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) #

Package database for installing local packages into

platformOnlyRelDir :: (MonadReader env m, HasPlatform env, MonadThrow m) => m (Path Rel Dir) #

Relative directory for the platform identifier

platformGhcRelDir :: (MonadReader env m, HasPlatform env, HasGHCVariant env, MonadThrow m) => m (Path Rel Dir) #

Relative directory for the platform identifier

useShaPathOnWindows :: MonadThrow m => Path Rel Dir -> m (Path Rel Dir) #

This is an attempt to shorten stack paths on Windows to decrease our chances of hitting 260 symbol path limit. The idea is to calculate SHA1 hash of the path used on other architectures, encode with base 16 and take first 8 symbols of it.

getWorkDir :: (MonadReader env m, HasConfig env) => m (Path Rel Dir) #

".stack-work"

Command-specific types

Eval

data EvalOpts #

Constructors

EvalOpts
Fields evalArg :: !String evalExtra :: !ExecOptsExtra

Instances

Show EvalOpts #
Methods showsPrec :: Int -> EvalOpts -> ShowS # show :: EvalOpts -> String # showList :: [EvalOpts] -> ShowS #

Exec

data ExecOpts #

Constructors

ExecOpts
Fields eoCmd :: !SpecialExecCmd eoArgs :: ![String] eoExtra :: !ExecOptsExtra

Instances

Show ExecOpts #
Methods showsPrec :: Int -> ExecOpts -> ShowS # show :: ExecOpts -> String # showList :: [ExecOpts] -> ShowS #

data SpecialExecCmd #

Constructors

ExecCmd String
ExecGhc
ExecRunGhc

Instances

Eq SpecialExecCmd #
Methods (==) :: SpecialExecCmd -> SpecialExecCmd -> Bool # (/=) :: SpecialExecCmd -> SpecialExecCmd -> Bool #
Show SpecialExecCmd #
Methods showsPrec :: Int -> SpecialExecCmd -> ShowS # show :: SpecialExecCmd -> String # showList :: [SpecialExecCmd] -> ShowS #

data ExecOptsExtra #

Constructors

ExecOptsPlain
ExecOptsEmbellished
Fields eoEnvSettings :: !EnvSettings eoPackages :: ![String]

Instances

Show ExecOptsExtra #
Methods showsPrec :: Int -> ExecOptsExtra -> ShowS # show :: ExecOptsExtra -> String # showList :: [ExecOptsExtra] -> ShowS #

Setup

data DownloadInfo #

Information for a file to download.

Constructors

DownloadInfo
Fields downloadInfoUrl :: Text downloadInfoContentLength :: Maybe Int downloadInfoSha1 :: Maybe ByteString

Instances

Show DownloadInfo #
Methods showsPrec :: Int -> DownloadInfo -> ShowS # show :: DownloadInfo -> String # showList :: [DownloadInfo] -> ShowS #
FromJSON (WithJSONWarnings DownloadInfo) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings DownloadInfo)

data VersionedDownloadInfo #

Constructors

VersionedDownloadInfo
Fields vdiVersion :: Version vdiDownloadInfo :: DownloadInfo

Instances

Show VersionedDownloadInfo #
Methods showsPrec :: Int -> VersionedDownloadInfo -> ShowS # show :: VersionedDownloadInfo -> String # showList :: [VersionedDownloadInfo] -> ShowS #
FromJSON (WithJSONWarnings VersionedDownloadInfo) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings VersionedDownloadInfo)

data SetupInfo #

Constructors

SetupInfo
Fields siSevenzExe :: Maybe DownloadInfo siSevenzDll :: Maybe DownloadInfo siMsys2 :: Map Text VersionedDownloadInfo siGHCs :: Map Text (Map Version DownloadInfo) siGHCJSs :: Map Text (Map CompilerVersion DownloadInfo) siStack :: Map Text (Map Version DownloadInfo)

Instances

Show SetupInfo #
Methods showsPrec :: Int -> SetupInfo -> ShowS # show :: SetupInfo -> String # showList :: [SetupInfo] -> ShowS #
Monoid SetupInfo #	For `siGHCs` and `siGHCJSs` fields maps are deeply merged. For all fields the values from the last `SetupInfo` win.
Methods mempty :: SetupInfo # mappend :: SetupInfo -> SetupInfo -> SetupInfo # mconcat :: [SetupInfo] -> SetupInfo #
FromJSON (WithJSONWarnings SetupInfo) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings SetupInfo)

data SetupInfoLocation #

Remote or inline SetupInfo

Constructors

SetupInfoFileOrURL String
SetupInfoInline SetupInfo

Instances

Show SetupInfoLocation #
Methods showsPrec :: Int -> SetupInfoLocation -> ShowS # show :: SetupInfoLocation -> String # showList :: [SetupInfoLocation] -> ShowS #
FromJSON (WithJSONWarnings SetupInfoLocation) #
Methods parseJSON :: Value -> Parser (WithJSONWarnings SetupInfoLocation)

Docker entrypoint

data DockerEntrypoint #

Data passed into Docker container for the Docker entrypoint's use

Constructors

DockerEntrypoint
Fields deUser :: !(Maybe DockerUser) UIDGIDetc of host user, if we wish to perform UID/GID switch in container

Instances

Read DockerEntrypoint #
Methods readsPrec :: Int -> ReadS DockerEntrypoint # readList :: ReadS [DockerEntrypoint] # readPrec :: ReadPrec DockerEntrypoint # readListPrec :: ReadPrec [DockerEntrypoint] #
Show DockerEntrypoint #
Methods showsPrec :: Int -> DockerEntrypoint -> ShowS # show :: DockerEntrypoint -> String # showList :: [DockerEntrypoint] -> ShowS #

data DockerUser #

Docker host user info

Constructors

DockerUser
Fields duUid :: UserID uid duGid :: GroupID gid duGroups :: [GroupID] Supplemantal groups duUmask :: FileMode File creation mask }

Instances

Read DockerUser #
Methods readsPrec :: Int -> ReadS DockerUser # readList :: ReadS [DockerUser] # readPrec :: ReadPrec DockerUser # readListPrec :: ReadPrec [DockerUser] #
Show DockerUser #
Methods showsPrec :: Int -> DockerUser -> ShowS # show :: DockerUser -> String # showList :: [DockerUser] -> ShowS #