Safe Haskell	None
Language	Haskell2010

Stack.Types.Config

Description

The Config type.

Synopsis

Documentation

data Config Source

The top-level Stackage configuration.

Constructors

Config

Fields

configStackRoot :: !(Path Abs Dir)
~/.stack more often than not
configDocker :: !DockerOpts
configEnvOverride :: !(EnvSettings -> IO EnvOverride)
Environment variables to be passed to external tools
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
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.
configLatestSnapshotUrl :: !Text
URL for a JSON file containing information on the latest snapshots available.
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
configConfigMonoid :: !ConfigMonoid
ConfigMonoid used to generate this
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 :: !(Map (Maybe PackageName) [Text])
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

Instances

HasConfig Config Source
Methods getConfig :: Config -> Config Source
HasPlatform Config Source
Methods getPlatform :: Config -> Platform Source
HasStackRoot Config Source
Methods getStackRoot :: Config -> Path Abs Dir Source

data PackageIndex Source

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 Source
Methods showsPrec :: Int -> PackageIndex -> ShowS show :: PackageIndex -> String showList :: [PackageIndex] -> ShowS

newtype IndexName Source

Unique name for a package index

Constructors

IndexName
Fields unIndexName :: ByteString

Instances

Eq IndexName Source
Methods (==) :: IndexName -> IndexName -> Bool (/=) :: IndexName -> IndexName -> Bool
Ord IndexName Source
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 Source
Methods showsPrec :: Int -> IndexName -> ShowS show :: IndexName -> String showList :: [IndexName] -> ShowS
Binary IndexName Source
Methods put :: IndexName -> Put get :: Get IndexName
ToJSON IndexName Source
Methods toJSON :: IndexName -> Value
FromJSON IndexName Source
Methods parseJSON :: Value -> Parser IndexName
Hashable IndexName Source
Methods hashWithSalt :: Int -> IndexName -> Int hash :: IndexName -> Int

indexNameText :: IndexName -> Text Source

data IndexLocation Source

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 Source
Methods (==) :: IndexLocation -> IndexLocation -> Bool (/=) :: IndexLocation -> IndexLocation -> Bool
Ord IndexLocation Source
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 Source
Methods showsPrec :: Int -> IndexLocation -> ShowS show :: IndexLocation -> String showList :: [IndexLocation] -> ShowS

data EnvSettings Source

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 Source
Methods (==) :: EnvSettings -> EnvSettings -> Bool (/=) :: EnvSettings -> EnvSettings -> Bool
Ord EnvSettings Source
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 Source
Methods showsPrec :: Int -> EnvSettings -> ShowS show :: EnvSettings -> String showList :: [EnvSettings] -> ShowS

data ExecOpts Source

Constructors

ExecOpts
Fields eoCmd :: !(Maybe String) Usage of `Maybe` here is nothing more than a hack, to avoid some weird bug in optparse-applicative. See: https://github.com/commercialhaskell/stack/issues/806 eoArgs :: ![String] eoExtra :: !ExecOptsExtra

data ExecOptsExtra Source

Constructors

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

data GlobalOpts Source

Parsed global command-line options.

Constructors

GlobalOpts
Fields globalReExec :: !Bool globalLogLevel :: !LogLevel Log level globalConfigMonoid :: !ConfigMonoid Config monoid, for passing into `loadConfig` globalResolver :: !(Maybe AbstractResolver) Resolver override globalTerminal :: !Bool We're in a terminal? globalStackYaml :: !(Maybe FilePath) Override project stack.yaml globalModifyCodePage :: !Bool Force the code page to UTF-8 on Windows

Instances

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

data AbstractResolver Source

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 Source
Methods showsPrec :: Int -> AbstractResolver -> ShowS show :: AbstractResolver -> String showList :: [AbstractResolver] -> ShowS

defaultLogLevel :: LogLevel Source

Default logging level should be something useful but not crazy.

data BuildConfig Source

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 :: !Resolver
How we resolve which dependencies to install given a set of packages.
bcWantedCompiler :: !CompilerVersion
Compiler version wanted for this build
bcPackageEntries :: ![PackageEntry]
Local packages identified by a path, Bool indicates whether it is a non-dependency (the opposite of peExtraDep)
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.
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 :: !(Map PackageName (Map FlagName Bool))
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 Source
Methods getBuildConfig :: BuildConfig -> BuildConfig Source
HasConfig BuildConfig Source
Methods getConfig :: BuildConfig -> Config Source
HasGHCVariant BuildConfig Source
Methods getGHCVariant :: BuildConfig -> GHCVariant Source
HasPlatform BuildConfig Source
Methods getPlatform :: BuildConfig -> Platform Source
HasStackRoot BuildConfig Source
Methods getStackRoot :: BuildConfig -> Path Abs Dir Source

bcRoot :: BuildConfig -> Path Abs Dir Source

Directory containing the project's stack.yaml file

bcWorkDir :: BuildConfig -> Path Abs Dir Source

Directory containing the project's stack.yaml file

data EnvConfig Source

Configuration after the environment has been setup.

Constructors

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

Instances

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

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

Methods

getEnvConfig :: r -> EnvConfig Source

Instances

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

data LoadConfig m Source

Value returned by loadConfig.

Constructors

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

data PackageEntry Source

Constructors

PackageEntry

Fields

peExtraDepMaybe :: !(Maybe Bool)
Is this package a dependency? This means the local package will be treated just like an extra-deps: 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
peValidWanted :: !(Maybe Bool)
Deprecated name meaning the opposite of peExtraDep. Only present to provide deprecation warnings to users.
peLocation :: !PackageLocation
peSubdirs :: ![FilePath]

Instances

Show PackageEntry Source
Methods showsPrec :: Int -> PackageEntry -> ShowS show :: PackageEntry -> String showList :: [PackageEntry] -> ShowS
ToJSON PackageEntry Source
Methods toJSON :: PackageEntry -> Value

peExtraDep :: PackageEntry -> Bool Source

Once peValidWanted is removed, this should just become the field name in PackageEntry.

data PackageLocation Source

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`.
PLHttpTarball Text
PLGit Text Text	URL and commit

Instances

Show PackageLocation Source
Methods showsPrec :: Int -> PackageLocation -> ShowS show :: PackageLocation -> String showList :: [PackageLocation] -> ShowS
ToJSON PackageLocation Source
Methods toJSON :: PackageLocation -> Value

data Project Source

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

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 :: !(Map PackageName (Map FlagName Bool))
Per-package flag overrides
projectResolver :: !Resolver
How we resolve which dependencies to use

Instances

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

data Resolver Source

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

Constructors

ResolverSnapshot SnapName	Use an official snapshot from the Stackage project, either an LTS Haskell or Stackage Nightly
ResolverCompiler !CompilerVersion	Require a specific compiler version, but otherwise provide no build plan. Intended for use cases where end user wishes to specify all upstream dependencies manually, such as using a dependency solver.
ResolverCustom !Text !Text	A custom resolver based on the given name and URL. This file is assumed to be completely immutable.

Instances

Show Resolver Source
Methods showsPrec :: Int -> Resolver -> ShowS show :: Resolver -> String showList :: [Resolver] -> ShowS
ToJSON Resolver Source
Methods toJSON :: Resolver -> Value

resolverName :: Resolver -> Text Source

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

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

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

class HasStackRoot env where Source

Class for environment values which have access to the stack root

Minimal complete definition

Nothing

Methods

getStackRoot :: env -> Path Abs Dir Source

Instances

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

class HasPlatform env where Source

Class for environment values which have a Platform

Minimal complete definition

Nothing

Methods

getPlatform :: env -> Platform Source

Instances

HasPlatform Platform Source
Methods getPlatform :: Platform -> Platform Source
HasPlatform EnvConfig Source
Methods getPlatform :: EnvConfig -> Platform Source
HasPlatform BuildConfig Source
Methods getPlatform :: BuildConfig -> Platform Source
HasPlatform Config Source
Methods getPlatform :: Config -> Platform Source
HasPlatform MiniConfig Source
Methods getPlatform :: MiniConfig -> Platform Source
HasPlatform config => HasPlatform (Env config) Source
Methods getPlatform :: Env config -> Platform Source

class HasGHCVariant env where Source

Class for environment values which have a GHCVariant

Minimal complete definition

Nothing

Methods

getGHCVariant :: env -> GHCVariant Source

Instances

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

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

Class for environment values that can provide a Config.

Minimal complete definition

Nothing

Methods

getConfig :: env -> Config Source

Instances

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

class HasConfig env => HasBuildConfig env where Source

Class for environment values that can provide a BuildConfig.

Methods

getBuildConfig :: env -> BuildConfig Source

Instances

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

data ConfigMonoid Source

Constructors

ConfigMonoid

Fields

configMonoidDockerOpts :: !DockerOptsMonoid
Docker options.
configMonoidConnectionCount :: !(Maybe Int)
See: configConnectionCount
configMonoidHideTHLoading :: !(Maybe Bool)
See: configHideTHLoading
configMonoidLatestSnapshotUrl :: !(Maybe Text)
See: configLatestSnapshotUrl
configMonoidPackageIndices :: !(Maybe [PackageIndex])
See: configPackageIndices
configMonoidSystemGHC :: !(Maybe Bool)
See: configSystemGHC
configMonoidInstallGHC :: !(Maybe Bool)
See: configInstallGHC
configMonoidSkipGHCCheck :: !(Maybe Bool)
See: configSkipGHCCheck
configMonoidSkipMsys :: !(Maybe Bool)
See: configSkipMsys
configMonoidCompilerCheck :: !(Maybe VersionCheck)
See: configCompilerCheck
configMonoidRequireStackVersion :: !VersionRange
See: configRequireStackVersion
configMonoidOS :: !(Maybe String)
Used for overriding the platform
configMonoidArch :: !(Maybe String)
Used for overriding the platform
configMonoidGHCVariant :: !(Maybe GHCVariant)
Used for overriding the GHC variant
configMonoidJobs :: !(Maybe Int)
See: configJobs
configMonoidExtraIncludeDirs :: !(Set Text)
See: configExtraIncludeDirs
configMonoidExtraLibDirs :: !(Set Text)
See: configExtraLibDirs
configMonoidConcurrentTests :: !(Maybe Bool)
See: configConcurrentTests
configMonoidLocalBinPath :: !(Maybe FilePath)
Used to override the binary installation dir
configMonoidImageOpts :: !ImageOptsMonoid
Image creation options.
configMonoidTemplateParameters :: !(Map Text Text)
Template parameters.
configMonoidScmInit :: !(Maybe SCM)
Initialize SCM (e.g. git init) when making new projects?
configMonoidGhcOptions :: !(Map (Maybe PackageName) [Text])
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 :: !(Maybe PvpBounds)
See configPvpBounds

Instances

Show ConfigMonoid Source
Methods showsPrec :: Int -> ConfigMonoid -> ShowS show :: ConfigMonoid -> String showList :: [ConfigMonoid] -> ShowS
Monoid ConfigMonoid Source
Methods mempty :: ConfigMonoid mappend :: ConfigMonoid -> ConfigMonoid -> ConfigMonoid mconcat :: [ConfigMonoid] -> ConfigMonoid

parseConfigMonoidJSON :: Object -> WarningParser ConfigMonoid Source

Parse a partial configuration. Used both to parse both a standalone config file and a project file, so that a sub-parser is not required, which would interfere with warnings for missing fields.

newtype VersionRangeJSON Source

Newtype for non-orphan FromJSON instance.

Constructors

VersionRangeJSON
Fields unVersionRangeJSON :: VersionRange

Instances

FromJSON VersionRangeJSON Source	Parse VersionRange.
Methods parseJSON :: Value -> Parser VersionRangeJSON

data ConfigException Source

Instances

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

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

Helper function to ask the environment and apply getConfig

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

Get the URL to request the information on the latest snapshots

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

Root for a specific package index

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

Location of the 00-index.cache file

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

Location of the 00-index.tar file

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

Location of the 00-index.tar.gz file

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

Location of a package tarball

workDirRel :: Path Rel Dir Source

configProjectWorkDir :: (HasBuildConfig env, MonadReader env m) => m (Path Abs Dir) Source

Per-project work dir

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

File containing the installed cache, see Stack.PackageDump

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

Relative directory for the platform identifier

platformVariantRelDir :: (MonadReader env m, HasPlatform env, HasGHCVariant env, MonadThrow m) => m (Path Rel Dir) Source

Relative directory for the platform identifier

configShakeFilesDir :: (MonadReader env m, HasBuildConfig env) => m (Path Abs Dir) Source

Path to .shake files.

configLocalUnpackDir :: (MonadReader env m, HasBuildConfig env) => m (Path Abs Dir) Source

Where to unpack packages for local build

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

Directory containing snapshots

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

Installation root for dependencies

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

Installation root for locals

compilerVersionDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Rel Dir) Source

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

Package database for installing dependencies into

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

Package database for installing local packages into

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

Directory for holding flag cache information

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

Where to store mini build plan caches

bindirSuffix :: Path Rel Dir Source

Suffix applied to an installation root to get the bin dir

docDirSuffix :: Path Rel Dir Source

Suffix applied to an installation root to get the doc dir

hpcDirSuffix :: Path Rel Dir Source

Suffix applied to an installation root to get the hpc dir

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

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

Bool indicates whether or not to include the locals

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

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

minimalEnvSettings :: EnvSettings Source

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

data ProjectAndConfigMonoid Source

Constructors

ProjectAndConfigMonoid !Project !ConfigMonoid

Instances

(~) * warnings [JSONWarning] => FromJSON (ProjectAndConfigMonoid, warnings) Source
Methods parseJSON :: Value -> Parser (ProjectAndConfigMonoid, warnings)

packageEntryCurrDir :: PackageEntry Source

A PackageEntry for the current directory, used as a default

data SCM Source

A software control system.

Constructors

Git

Instances

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

data GHCVariant Source

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 Source
Methods showsPrec :: Int -> GHCVariant -> ShowS show :: GHCVariant -> String showList :: [GHCVariant] -> ShowS
FromJSON GHCVariant Source
Methods parseJSON :: Value -> Parser GHCVariant
HasGHCVariant GHCVariant Source
Methods getGHCVariant :: GHCVariant -> GHCVariant Source

ghcVariantName :: GHCVariant -> String Source

Render a GHC variant to a String.

ghcVariantSuffix :: GHCVariant -> String Source

Render a GHC variant to a String suffix.

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

Parse GHC variant from a String.

data DownloadInfo Source

Information for a file to download.

Constructors

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

Instances

Show DownloadInfo Source
Methods showsPrec :: Int -> DownloadInfo -> ShowS show :: DownloadInfo -> String showList :: [DownloadInfo] -> ShowS

parseDownloadInfoFromObject :: Object -> WarningParser DownloadInfo Source

Parse JSON in existing object for DownloadInfo

data VersionedDownloadInfo Source

Constructors

VersionedDownloadInfo
Fields vdiVersion :: Version vdiDownloadInfo :: DownloadInfo

Instances

Show VersionedDownloadInfo Source
Methods showsPrec :: Int -> VersionedDownloadInfo -> ShowS show :: VersionedDownloadInfo -> String showList :: [VersionedDownloadInfo] -> ShowS

data SetupInfo Source

Constructors

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

Instances

Show SetupInfo Source
Methods showsPrec :: Int -> SetupInfo -> ShowS show :: SetupInfo -> String showList :: [SetupInfo] -> ShowS
Monoid SetupInfo Source
Methods mempty :: SetupInfo mappend :: SetupInfo -> SetupInfo -> SetupInfo mconcat :: [SetupInfo] -> SetupInfo

data SetupInfoLocation Source

Remote or inline SetupInfo

Constructors

SetupInfoFileOrURL String
SetupInfoInline SetupInfo

Instances

Show SetupInfoLocation Source
Methods showsPrec :: Int -> SetupInfoLocation -> ShowS show :: SetupInfoLocation -> String showList :: [SetupInfoLocation] -> ShowS

data PvpBounds Source

How PVP bounds should be added to .cabal files

Constructors

PvpBoundsNone
PvpBoundsUpper
PvpBoundsLower
PvpBoundsBoth

Instances

Bounded PvpBounds Source
Methods minBound :: PvpBounds maxBound :: PvpBounds
Enum PvpBounds Source
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 Source
Methods (==) :: PvpBounds -> PvpBounds -> Bool (/=) :: PvpBounds -> PvpBounds -> Bool
Ord PvpBounds Source
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 Source
Methods readsPrec :: Int -> ReadS PvpBounds readList :: ReadS [PvpBounds] readPrec :: ReadPrec PvpBounds readListPrec :: ReadPrec [PvpBounds]
Show PvpBounds Source
Methods showsPrec :: Int -> PvpBounds -> ShowS show :: PvpBounds -> String showList :: [PvpBounds] -> ShowS
ToJSON PvpBounds Source
Methods toJSON :: PvpBounds -> Value
FromJSON PvpBounds Source
Methods parseJSON :: Value -> Parser PvpBounds

pvpBoundsText :: PvpBounds -> Text Source

parsePvpBounds :: Text -> Either String PvpBounds Source

ParseConfigFileException (Path Abs File) ParseException
ParseResolverException Text
NoProjectConfigFound (Path Abs Dir) (Maybe Text)
UnexpectedTarballContents [Path Abs Dir] [Path Abs File]
BadStackVersionException VersionRange
NoMatchingSnapshot [SnapName]
NoSuchDirectory FilePath
ParseGHCVariantException String