Stack.Types.Config

The Config type.

Main configuration types and classes

HasPlatform & HasStackRoot

class HasPlatform env where

Class for environment values which have a Platform

Minimal complete definition

Nothing

Methods

platformL :: Lens' env Platform

platformL :: HasConfig env => Lens' env Platform

platformVariantL :: Lens' env PlatformVariant

platformVariantL :: HasConfig env => Lens' env PlatformVariant

Instances

HasPlatform LoadConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' LoadConfig Platform

platformVariantL :: Lens' LoadConfig PlatformVariant

HasPlatform EnvConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' EnvConfig Platform

platformVariantL :: Lens' EnvConfig PlatformVariant

HasPlatform BuildConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' BuildConfig Platform

platformVariantL :: Lens' BuildConfig PlatformVariant

HasPlatform Config

Defined in Stack.Types.Config

Methods

platformL :: Lens' Config Platform

platformVariantL :: Lens' Config PlatformVariant

HasPlatform MiniConfig

Defined in Stack.Config

Methods

platformL :: Lens' MiniConfig Platform

platformVariantL :: Lens' MiniConfig PlatformVariant

HasPlatform (Platform, PlatformVariant)

Defined in Stack.Types.Config

Methods

platformL :: Lens' (Platform, PlatformVariant) Platform

platformVariantL :: Lens' (Platform, PlatformVariant) PlatformVariant

data PlatformVariant

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

Constructors

PlatformVariantNone

PlatformVariant String

Instances

HasPlatform (Platform, PlatformVariant)

Defined in Stack.Types.Config

Methods

platformL :: Lens' (Platform, PlatformVariant) Platform

platformVariantL :: Lens' (Platform, PlatformVariant) PlatformVariant

Config & HasConfig

data Config

The top-level Stackage configuration.

Constructors

Config

Fields

• 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

• configProcessContextSettings :: !(EnvSettings -> IO ProcessContext)

  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)

• 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.

• configGHCBuild :: !(Maybe CompilerBuild)

  Override build of the compiler distribution (e.g. standard, gmp4, tinfo6)

• 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.

• 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 sandboxed 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

• configOverrideGccPath :: !(Maybe (Path Abs File))

  Optional gcc override path

• configOverrideHpack :: !HpackExecutable

  Use Hpack executable (overrides bundled Hpack)

• configExtraIncludeDirs :: !(Set FilePath)
  • -extra-include-dirs arguments
• configExtraLibDirs :: !(Set FilePath)
  • -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.

• configGhcOptionsByName :: !(Map PackageName [Text])

  Additional GHC options to apply to specific packages.

• configGhcOptionsByCat :: !(Map ApplyGhcOptions [Text])

  Additional GHC options to apply to categories of packages

• 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.

• configDumpLogs :: !DumpLogs

  Dump logs of local non-dependencies when doing a build.

• configMaybeProject :: !(Maybe (Project, Path Abs File))

  Just when a local project can be found, Nothing when stack must fall back on the implicit global project.

• configAllowLocals :: !Bool

  Are we allowed to build local packages? The script command disallows this.

• configSaveHackageCreds :: !Bool

  Should we save Hackage credentials to a file?

• configHackageBaseUrl :: !Text

  Hackage base URL used when uploading packages

• configRunner :: !Runner
• configCabalLoader :: !CabalLoader

Instances

HasProcessContext Config

Defined in Stack.Types.Config

Methods

processContextL :: Lens' Config ProcessContext

HasLogFunc Config

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' Config LogFunc

HasRunner Config

Defined in Stack.Types.Config

Methods

runnerL :: Lens' Config Runner

HasCabalLoader Config

Defined in Stack.Types.Config

Methods

cabalLoaderL :: Lens' Config CabalLoader

HasConfig Config

Defined in Stack.Types.Config

Methods

configL :: Lens' Config Config

HasPlatform Config

Defined in Stack.Types.Config

Methods

platformL :: Lens' Config Platform

platformVariantL :: Lens' Config PlatformVariant

class (HasPlatform env, HasProcessContext env, HasCabalLoader env) => HasConfig env where

Class for environment values that can provide a Config.

Minimal complete definition

Nothing

Methods

configL :: Lens' env Config

configL :: HasBuildConfig env => Lens' env Config

Instances

HasConfig LoadConfig

Defined in Stack.Types.Config

Methods

configL :: Lens' LoadConfig Config

HasConfig EnvConfig

Defined in Stack.Types.Config

Methods

configL :: Lens' EnvConfig Config

HasConfig BuildConfig

Defined in Stack.Types.Config

Methods

configL :: Lens' BuildConfig Config

HasConfig Config

Defined in Stack.Types.Config

Methods

configL :: Lens' Config Config

HasConfig MiniConfig

Defined in Stack.Config

Methods

configL :: Lens' MiniConfig Config

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

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.

These are the components which know nothing about local configuration.

Constructors

BuildConfig

Fields

• bcConfig :: !Config
• bcSnapshotDef :: !SnapshotDef

  Build plan wanted for this build

• bcGHCVariant :: !GHCVariant

  The variant of GHC used to select a GHC bindist.

• bcPackages :: ![PackageLocation Subdirs]

  Local packages

• bcDependencies :: ![PackageLocationIndex Subdirs]

  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 projectRootL / "stack.yaml"

  FIXME MSS 2016-12-08: is the above comment still true? projectRootL is defined in terms of bcStackYaml

• 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.

Instances

HasProcessContext BuildConfig

Defined in Stack.Types.Config

Methods

processContextL :: Lens' BuildConfig ProcessContext

HasLogFunc BuildConfig

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' BuildConfig LogFunc

HasRunner BuildConfig

Defined in Stack.Types.Config

Methods

runnerL :: Lens' BuildConfig Runner

HasCabalLoader BuildConfig

Defined in Stack.Types.Config

Methods

cabalLoaderL :: Lens' BuildConfig CabalLoader

HasBuildConfig BuildConfig

Defined in Stack.Types.Config

Methods

buildConfigL :: Lens' BuildConfig BuildConfig

HasConfig BuildConfig

Defined in Stack.Types.Config

Methods

configL :: Lens' BuildConfig Config

HasGHCVariant BuildConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: Lens' BuildConfig GHCVariant

HasPlatform BuildConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' BuildConfig Platform

platformVariantL :: Lens' BuildConfig PlatformVariant

data LocalPackages

Constructors

LocalPackages

Fields

• lpProject :: !(Map PackageName LocalPackageView)
• lpDependencies :: !(Map PackageName (GenericPackageDescription, PackageLocationIndex FilePath))

data LocalPackageView

A view of a local package needed for resolving components

Constructors

LocalPackageView

Fields

• lpvCabalFP :: !(Path Abs File)
• lpvGPD :: !GenericPackageDescription
• lpvLoc :: !(PackageLocation FilePath)

lpvRoot :: LocalPackageView -> Path Abs Dir

Root directory for the given LocalPackageView

lpvName :: LocalPackageView -> PackageName

Package name for the given 'LocalPackageView

lpvVersion :: LocalPackageView -> Version

Version for the given 'LocalPackageView

lpvComponents :: LocalPackageView -> Set NamedComponent

All components available in the given LocalPackageView

stackYamlL :: HasBuildConfig env => Lens' env (Path Abs File)

projectRootL :: HasBuildConfig env => Getting r env (Path Abs Dir)

Directory containing the project's stack.yaml file

class HasConfig env => HasBuildConfig env where

Minimal complete definition

Nothing

Methods

buildConfigL :: Lens' env BuildConfig

buildConfigL :: HasEnvConfig env => Lens' env BuildConfig

Instances

HasBuildConfig EnvConfig

Defined in Stack.Types.Config

Methods

buildConfigL :: Lens' EnvConfig BuildConfig

HasBuildConfig BuildConfig

Defined in Stack.Types.Config

Methods

buildConfigL :: Lens' BuildConfig BuildConfig

GHCVariant & HasGHCVariant

data GHCVariant

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

Constructors

GHCStandard

Standard bindist

GHCIntegerSimple

Bindist that uses integer-simple

GHCCustom String

Other bindists

Instances

Show GHCVariant

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> GHCVariant -> ShowS

show :: GHCVariant -> String

showList :: [GHCVariant] -> ShowS

FromJSON GHCVariant

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser GHCVariant

parseJSONList :: Value -> Parser [GHCVariant]

HasGHCVariant GHCVariant

Defined in Stack.Types.Config

Methods

ghcVariantL :: Lens' 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

Minimal complete definition

Nothing

Methods

ghcVariantL :: Lens' env GHCVariant

ghcVariantL :: HasBuildConfig env => Lens' env GHCVariant

Instances

HasGHCVariant GHCVariant

Defined in Stack.Types.Config

Methods

ghcVariantL :: Lens' GHCVariant GHCVariant

HasGHCVariant EnvConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: Lens' EnvConfig GHCVariant

HasGHCVariant BuildConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: Lens' BuildConfig GHCVariant

HasGHCVariant MiniConfig

Defined in Stack.Config

Methods

ghcVariantL :: Lens' MiniConfig GHCVariant

snapshotsDir :: (MonadReader env m, HasEnvConfig 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

  This is the version of Cabal that stack will use to compile Setup.hs files in the build process.

  Note that this is not necessarily the same version as the one that stack depends on as a library and which is displayed when running stack list-dependencies | grep Cabal in the stack project.

• envConfigCompilerVersion :: !(CompilerVersion CVActual)

  The actual version of the compiler to be used, as opposed to wantedCompilerL, which provides the version specified by the build plan.

• envConfigCompilerBuild :: !CompilerBuild
• envConfigPackagesRef :: !(IORef (Maybe LocalPackages))

  Cache for getLocalPackages.

• envConfigLoadedSnapshot :: !LoadedSnapshot

  The fully resolved snapshot information.

Instances

HasProcessContext EnvConfig

Defined in Stack.Types.Config

Methods

processContextL :: Lens' EnvConfig ProcessContext

HasLogFunc EnvConfig

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' EnvConfig LogFunc

HasRunner EnvConfig

Defined in Stack.Types.Config

Methods

runnerL :: Lens' EnvConfig Runner

HasCabalLoader EnvConfig

Defined in Stack.Types.Config

Methods

cabalLoaderL :: Lens' EnvConfig CabalLoader

HasEnvConfig EnvConfig

Defined in Stack.Types.Config

Methods

envConfigL :: Lens' EnvConfig EnvConfig

HasBuildConfig EnvConfig

Defined in Stack.Types.Config

Methods

buildConfigL :: Lens' EnvConfig BuildConfig

HasConfig EnvConfig

Defined in Stack.Types.Config

Methods

configL :: Lens' EnvConfig Config

HasGHCVariant EnvConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: Lens' EnvConfig GHCVariant

HasPlatform EnvConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' EnvConfig Platform

platformVariantL :: Lens' EnvConfig PlatformVariant

class (HasBuildConfig env, HasGHCVariant env) => HasEnvConfig env where

Methods

envConfigL :: Lens' env EnvConfig

Instances

HasEnvConfig EnvConfig

Defined in Stack.Types.Config

Methods

envConfigL :: Lens' EnvConfig EnvConfig

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 do 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

Defined in Stack.Types.Config

Methods

minBound :: ApplyGhcOptions

maxBound :: ApplyGhcOptions

Enum ApplyGhcOptions

Defined in Stack.Types.Config

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

Defined in Stack.Types.Config

Methods

(==) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool

(/=) :: ApplyGhcOptions -> ApplyGhcOptions -> Bool

Ord ApplyGhcOptions

Defined in Stack.Types.Config

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

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS ApplyGhcOptions

readList :: ReadS [ApplyGhcOptions]

readPrec :: ReadPrec ApplyGhcOptions

readListPrec :: ReadPrec [ApplyGhcOptions]

Show ApplyGhcOptions

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> ApplyGhcOptions -> ShowS

show :: ApplyGhcOptions -> String

showList :: [ApplyGhcOptions] -> ShowS

FromJSON ApplyGhcOptions

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser ApplyGhcOptions

parseJSONList :: Value -> Parser [ApplyGhcOptions]

ConfigException

data HpackExecutable

Constructors

HpackBundled

HpackCommand String

Instances

Eq HpackExecutable

Defined in Stack.Types.Config

Methods

(==) :: HpackExecutable -> HpackExecutable -> Bool

(/=) :: HpackExecutable -> HpackExecutable -> Bool

Ord HpackExecutable

Defined in Stack.Types.Config

Methods

compare :: HpackExecutable -> HpackExecutable -> Ordering

(<) :: HpackExecutable -> HpackExecutable -> Bool

(<=) :: HpackExecutable -> HpackExecutable -> Bool

(>) :: HpackExecutable -> HpackExecutable -> Bool

(>=) :: HpackExecutable -> HpackExecutable -> Bool

max :: HpackExecutable -> HpackExecutable -> HpackExecutable

min :: HpackExecutable -> HpackExecutable -> HpackExecutable

Read HpackExecutable

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS HpackExecutable

readList :: ReadS [HpackExecutable]

readPrec :: ReadPrec HpackExecutable

readListPrec :: ReadPrec [HpackExecutable]

Show HpackExecutable

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> HpackExecutable -> ShowS

show :: HpackExecutable -> String

showList :: [HpackExecutable] -> ShowS

data ConfigException

Constructors

ParseConfigFileException (Path Abs File) ParseException

ParseCustomSnapshotException Text ParseException

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 !Text String

ResolverPartial WhichSolverCmd !Text 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)

FailedToCloneRepo String

ManualGHCVariantSettingsAreIncompatibleWithSystemGHC

NixRequiresSystemGhc

NoResolverWhenUsingNoLocalConfig

InvalidResolverForNoLocalConfig String

DuplicateLocalPackageNames ![(PackageName, [PackageLocationIndex FilePath])]

Instances

Show ConfigException

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> ConfigException -> ShowS

show :: ConfigException -> String

showList :: [ConfigException] -> ShowS

Exception ConfigException

Defined in Stack.Types.Config

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: clStackRoot

• configMonoidWorkDir :: !(First (Path Rel Dir))

  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: picIndices

• 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

• configMonoidArch :: !(First String)

  Used for overriding the platform

• configMonoidGHCVariant :: !(First GHCVariant)

  Used for overriding the platform

• configMonoidGHCBuild :: !(First CompilerBuild)

  Used for overriding the GHC build

• configMonoidJobs :: !(First Int)

  See: configJobs

• configMonoidExtraIncludeDirs :: !(Set FilePath)

  See: configExtraIncludeDirs

• configMonoidExtraLibDirs :: !(Set FilePath)

  See: configExtraLibDirs

• configMonoidOverrideGccPath :: !(First (Path Abs File))

  Allow users to override the path to gcc

• configMonoidOverrideHpack :: !(First FilePath)

  Use Hpack executable (overrides bundled Hpack)

• 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?

• configMonoidGhcOptionsByName :: !(MonoidMap PackageName (Dual [Text]))

  See configGhcOptionsByName. Uses Dual so that options from the configs on the right come first, so that they can be overridden.

• configMonoidGhcOptionsByCat :: !(MonoidMap ApplyGhcOptions (Dual [Text]))

  See configGhcOptionsAll. Uses Dual so that options from the configs on the right come first, so that they can be overridden.

• configMonoidExtraPath :: ![Path Abs Dir]

  Additional paths to search for executables in

• configMonoidSetupInfoLocations :: ![SetupInfoLocation]

  Additional setup info (inline or remote) to use for installing tools

• configMonoidLocalProgramsBase :: !(First (Path Abs Dir))

  Override the default local programs dir, where e.g. GHC is installed.

• 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.

• configMonoidDumpLogs :: !(First DumpLogs)

  See configDumpLogs

• configMonoidSaveHackageCreds :: !(First Bool)

  See configSaveHackageCreds

• configMonoidHackageBaseUrl :: !(First Text)

  See configHackageBaseUrl

• configMonoidIgnoreRevisionMismatch :: !(First Bool)

  See configIgnoreRevisionMismatch

Instances

Show ConfigMonoid

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> ConfigMonoid -> ShowS

show :: ConfigMonoid -> String

showList :: [ConfigMonoid] -> ShowS

Generic ConfigMonoid

Defined in Stack.Types.Config

Associated Types

type Rep ConfigMonoid :: Type -> Type

Methods

from :: ConfigMonoid -> Rep ConfigMonoid x

to :: Rep ConfigMonoid x -> ConfigMonoid

Semigroup ConfigMonoid

Defined in Stack.Types.Config

Methods

(<>) :: ConfigMonoid -> ConfigMonoid -> ConfigMonoid

sconcat :: NonEmpty ConfigMonoid -> ConfigMonoid

stimes :: Integral b => b -> ConfigMonoid -> ConfigMonoid

Monoid ConfigMonoid

Defined in Stack.Types.Config

Methods

mempty :: ConfigMonoid

mappend :: ConfigMonoid -> ConfigMonoid -> ConfigMonoid

mconcat :: [ConfigMonoid] -> ConfigMonoid

type Rep ConfigMonoid

Defined in Stack.Types.Config

type Rep ConfigMonoid = D1 (MetaData "ConfigMonoid" "Stack.Types.Config" "stack-1.9.1.1-6jz2L6XfBym9jbCxt3ojTR" False) (C1 (MetaCons "ConfigMonoid" PrefixI True) (((((S1 (MetaSel (Just "configMonoidStackRoot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (Path Abs Dir))) :*: S1 (MetaSel (Just "configMonoidWorkDir") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (Path Rel Dir)))) :*: (S1 (MetaSel (Just "configMonoidBuildOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BuildOptsMonoid) :*: (S1 (MetaSel (Just "configMonoidDockerOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DockerOptsMonoid) :*: S1 (MetaSel (Just "configMonoidNixOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NixOptsMonoid)))) :*: ((S1 (MetaSel (Just "configMonoidConnectionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Int)) :*: (S1 (MetaSel (Just "configMonoidHideTHLoading") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "configMonoidLatestSnapshotUrl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Text)))) :*: (S1 (MetaSel (Just "configMonoidUrls") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UrlsMonoid) :*: (S1 (MetaSel (Just "configMonoidPackageIndices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First [PackageIndex])) :*: S1 (MetaSel (Just "configMonoidSystemGHC") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))))) :*: (((S1 (MetaSel (Just "configMonoidInstallGHC") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: (S1 (MetaSel (Just "configMonoidSkipGHCCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "configMonoidSkipMsys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) :*: (S1 (MetaSel (Just "configMonoidCompilerCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First VersionCheck)) :*: (S1 (MetaSel (Just "configMonoidRequireStackVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IntersectingVersionRange) :*: S1 (MetaSel (Just "configMonoidArch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String))))) :*: ((S1 (MetaSel (Just "configMonoidGHCVariant") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First GHCVariant)) :*: (S1 (MetaSel (Just "configMonoidGHCBuild") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First CompilerBuild)) :*: S1 (MetaSel (Just "configMonoidJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Int)))) :*: (S1 (MetaSel (Just "configMonoidExtraIncludeDirs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Set FilePath)) :*: (S1 (MetaSel (Just "configMonoidExtraLibDirs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Set FilePath)) :*: S1 (MetaSel (Just "configMonoidOverrideGccPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (Path Abs File)))))))) :*: ((((S1 (MetaSel (Just "configMonoidOverrideHpack") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath)) :*: S1 (MetaSel (Just "configMonoidConcurrentTests") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) :*: (S1 (MetaSel (Just "configMonoidLocalBinPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath)) :*: (S1 (MetaSel (Just "configMonoidImageOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ImageOptsMonoid) :*: S1 (MetaSel (Just "configMonoidTemplateParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map Text Text))))) :*: ((S1 (MetaSel (Just "configMonoidScmInit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First SCM)) :*: (S1 (MetaSel (Just "configMonoidGhcOptionsByName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (MonoidMap PackageName (Dual [Text]))) :*: S1 (MetaSel (Just "configMonoidGhcOptionsByCat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (MonoidMap ApplyGhcOptions (Dual [Text]))))) :*: (S1 (MetaSel (Just "configMonoidExtraPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Path Abs Dir]) :*: (S1 (MetaSel (Just "configMonoidSetupInfoLocations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [SetupInfoLocation]) :*: S1 (MetaSel (Just "configMonoidLocalProgramsBase") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (Path Abs Dir))))))) :*: (((S1 (MetaSel (Just "configMonoidPvpBounds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First PvpBounds)) :*: (S1 (MetaSel (Just "configMonoidModifyCodePage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "configMonoidExplicitSetupDeps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map (Maybe PackageName) Bool)))) :*: (S1 (MetaSel (Just "configMonoidRebuildGhcOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: (S1 (MetaSel (Just "configMonoidApplyGhcOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First ApplyGhcOptions)) :*: S1 (MetaSel (Just "configMonoidAllowNewer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))))) :*: ((S1 (MetaSel (Just "configMonoidDefaultTemplate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First TemplateName)) :*: (S1 (MetaSel (Just "configMonoidAllowDifferentUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "configMonoidDumpLogs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First DumpLogs)))) :*: (S1 (MetaSel (Just "configMonoidSaveHackageCreds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: (S1 (MetaSel (Just "configMonoidHackageBaseUrl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Text)) :*: S1 (MetaSel (Just "configMonoidIgnoreRevisionMismatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))))))))

configMonoidInstallGHCName :: Text

configMonoidSystemGHCName :: Text

parseConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ConfigMonoid)

DumpLogs

data DumpLogs

Which build log files to dump

Constructors

DumpNoLogs

don't dump any logfiles

DumpWarningLogs

dump logfiles containing warnings

DumpAllLogs

dump all logfiles

Instances

Bounded DumpLogs

Defined in Stack.Types.Config

Methods

minBound :: DumpLogs

maxBound :: DumpLogs

Enum DumpLogs

Defined in Stack.Types.Config

Methods

succ :: DumpLogs -> DumpLogs

pred :: DumpLogs -> DumpLogs

toEnum :: Int -> DumpLogs

fromEnum :: DumpLogs -> Int

enumFrom :: DumpLogs -> [DumpLogs]

enumFromThen :: DumpLogs -> DumpLogs -> [DumpLogs]

enumFromTo :: DumpLogs -> DumpLogs -> [DumpLogs]

enumFromThenTo :: DumpLogs -> DumpLogs -> DumpLogs -> [DumpLogs]

Eq DumpLogs

Defined in Stack.Types.Config

Methods

(==) :: DumpLogs -> DumpLogs -> Bool

(/=) :: DumpLogs -> DumpLogs -> Bool

Ord DumpLogs

Defined in Stack.Types.Config

Methods

compare :: DumpLogs -> DumpLogs -> Ordering

(<) :: DumpLogs -> DumpLogs -> Bool

(<=) :: DumpLogs -> DumpLogs -> Bool

(>) :: DumpLogs -> DumpLogs -> Bool

(>=) :: DumpLogs -> DumpLogs -> Bool

max :: DumpLogs -> DumpLogs -> DumpLogs

min :: DumpLogs -> DumpLogs -> DumpLogs

Read DumpLogs

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS DumpLogs

readList :: ReadS [DumpLogs]

readPrec :: ReadPrec DumpLogs

readListPrec :: ReadPrec [DumpLogs]

Show DumpLogs

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> DumpLogs -> ShowS

show :: DumpLogs -> String

showList :: [DumpLogs] -> ShowS

FromJSON DumpLogs

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser DumpLogs

parseJSONList :: Value -> Parser [DumpLogs]

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

• esKeepGhcRts :: !Bool

  if True, keep GHCRTS variable in environment

Instances

Eq EnvSettings

Defined in Stack.Types.Config

Methods

(==) :: EnvSettings -> EnvSettings -> Bool

(/=) :: EnvSettings -> EnvSettings -> Bool

Ord EnvSettings

Defined in Stack.Types.Config

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

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> EnvSettings -> ShowS

show :: EnvSettings -> String

showList :: [EnvSettings] -> ShowS

minimalEnvSettings :: EnvSettings

defaultEnvSettings :: EnvSettings

Default EnvSettings which includes locals and GHC_PACKAGE_PATH.

Note that this also passes through the GHCRTS environment variable. See https://github.com/commercialhaskell/stack/issues/3444

plainEnvSettings :: EnvSettings

Environment settings which do not embellish the environment

Note that this also passes through the GHCRTS environment variable. See https://github.com/commercialhaskell/stack/issues/3444

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

• globalTimeInLog :: !Bool

  Whether to include timings in logs.

• globalConfigMonoid :: !ConfigMonoid

  Config monoid, for passing into loadConfig

• globalResolver :: !(Maybe AbstractResolver)

  Resolver override

• globalCompiler :: !(Maybe (CompilerVersion CVWanted))

  Compiler override

• globalTerminal :: !Bool

  We're in a terminal?

• globalColorWhen :: !ColorWhen

  When to use ansi terminal colors

• globalTermWidth :: !(Maybe Int)

  Terminal width override

• globalStackYaml :: !(StackYamlLoc FilePath)

  Override project stack.yaml

Instances

Show GlobalOpts

Defined in Stack.Types.Config

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

• globalMonoidTimeInLog :: !(First Bool)

  Whether to include timings in logs.

• globalMonoidConfigMonoid :: !ConfigMonoid

  Config monoid, for passing into loadConfig

• globalMonoidResolver :: !(First AbstractResolver)

  Resolver override

• globalMonoidCompiler :: !(First (CompilerVersion CVWanted))

  Compiler override

• globalMonoidTerminal :: !(First Bool)

  We're in a terminal?

• globalMonoidColorWhen :: !(First ColorWhen)

  When to use ansi colors

• globalMonoidTermWidth :: !(First Int)

  Terminal width override

• globalMonoidStackYaml :: !(First FilePath)

  Override project stack.yaml

Instances

Show GlobalOptsMonoid

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> GlobalOptsMonoid -> ShowS

show :: GlobalOptsMonoid -> String

showList :: [GlobalOptsMonoid] -> ShowS

Generic GlobalOptsMonoid

Defined in Stack.Types.Config

Associated Types

type Rep GlobalOptsMonoid :: Type -> Type

Methods

from :: GlobalOptsMonoid -> Rep GlobalOptsMonoid x

to :: Rep GlobalOptsMonoid x -> GlobalOptsMonoid

Semigroup GlobalOptsMonoid

Defined in Stack.Types.Config

Methods

(<>) :: GlobalOptsMonoid -> GlobalOptsMonoid -> GlobalOptsMonoid

sconcat :: NonEmpty GlobalOptsMonoid -> GlobalOptsMonoid

stimes :: Integral b => b -> GlobalOptsMonoid -> GlobalOptsMonoid

Monoid GlobalOptsMonoid

Defined in Stack.Types.Config

Methods

mempty :: GlobalOptsMonoid

mappend :: GlobalOptsMonoid -> GlobalOptsMonoid -> GlobalOptsMonoid

mconcat :: [GlobalOptsMonoid] -> GlobalOptsMonoid

type Rep GlobalOptsMonoid

Defined in Stack.Types.Config

type Rep GlobalOptsMonoid = D1 (MetaData "GlobalOptsMonoid" "Stack.Types.Config" "stack-1.9.1.1-6jz2L6XfBym9jbCxt3ojTR" False) (C1 (MetaCons "GlobalOptsMonoid" PrefixI True) (((S1 (MetaSel (Just "globalMonoidReExecVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String)) :*: S1 (MetaSel (Just "globalMonoidDockerEntrypoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First DockerEntrypoint))) :*: (S1 (MetaSel (Just "globalMonoidLogLevel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First LogLevel)) :*: (S1 (MetaSel (Just "globalMonoidTimeInLog") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "globalMonoidConfigMonoid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ConfigMonoid)))) :*: ((S1 (MetaSel (Just "globalMonoidResolver") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First AbstractResolver)) :*: (S1 (MetaSel (Just "globalMonoidCompiler") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (CompilerVersion CVWanted))) :*: S1 (MetaSel (Just "globalMonoidTerminal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) :*: (S1 (MetaSel (Just "globalMonoidColorWhen") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First ColorWhen)) :*: (S1 (MetaSel (Just "globalMonoidTermWidth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Int)) :*: S1 (MetaSel (Just "globalMonoidStackYaml") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath)))))))

data StackYamlLoc filepath

Constructors

SYLDefault

SYLOverride !filepath

SYLNoConfig !(Path Abs Dir)

FilePath is the directory containing the script file, used for resolving custom snapshot files.

Instances

Functor StackYamlLoc

Defined in Stack.Types.Config

Methods

fmap :: (a -> b) -> StackYamlLoc a -> StackYamlLoc b

(<$) :: a -> StackYamlLoc b -> StackYamlLoc a

Foldable StackYamlLoc

Defined in Stack.Types.Config

Methods

fold :: Monoid m => StackYamlLoc m -> m

foldMap :: Monoid m => (a -> m) -> StackYamlLoc a -> m

foldr :: (a -> b -> b) -> b -> StackYamlLoc a -> b

foldr' :: (a -> b -> b) -> b -> StackYamlLoc a -> b

foldl :: (b -> a -> b) -> b -> StackYamlLoc a -> b

foldl' :: (b -> a -> b) -> b -> StackYamlLoc a -> b

foldr1 :: (a -> a -> a) -> StackYamlLoc a -> a

foldl1 :: (a -> a -> a) -> StackYamlLoc a -> a

toList :: StackYamlLoc a -> [a]

null :: StackYamlLoc a -> Bool

length :: StackYamlLoc a -> Int

elem :: Eq a => a -> StackYamlLoc a -> Bool

maximum :: Ord a => StackYamlLoc a -> a

minimum :: Ord a => StackYamlLoc a -> a

sum :: Num a => StackYamlLoc a -> a

product :: Num a => StackYamlLoc a -> a

Traversable StackYamlLoc

Defined in Stack.Types.Config

Methods

traverse :: Applicative f => (a -> f b) -> StackYamlLoc a -> f (StackYamlLoc b)

sequenceA :: Applicative f => StackYamlLoc (f a) -> f (StackYamlLoc a)

mapM :: Monad m => (a -> m b) -> StackYamlLoc a -> m (StackYamlLoc b)

sequence :: Monad m => StackYamlLoc (m a) -> m (StackYamlLoc a)

Show filepath => Show (StackYamlLoc filepath)

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> StackYamlLoc filepath -> ShowS

show :: StackYamlLoc filepath -> String

showList :: [StackYamlLoc filepath] -> ShowS

defaultLogLevel :: LogLevel

Default logging level should be something useful but not crazy.

LoadConfig

data LoadConfig

Value returned by loadConfig.

Constructors

LoadConfig

Fields

• lcConfig :: !Config

  Top-level Stack configuration.

• lcLoadBuildConfig :: !(Maybe (CompilerVersion CVWanted) -> IO BuildConfig)

  Action to load the remaining BuildConfig.

• lcProjectRoot :: !(Maybe (Path Abs Dir))

  The project root directory, if in a project.

Instances

HasProcessContext LoadConfig

Defined in Stack.Types.Config

Methods

processContextL :: Lens' LoadConfig ProcessContext

HasLogFunc LoadConfig

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' LoadConfig LogFunc

HasRunner LoadConfig

Defined in Stack.Types.Config

Methods

runnerL :: Lens' LoadConfig Runner

HasCabalLoader LoadConfig

Defined in Stack.Types.Config

Methods

cabalLoaderL :: Lens' LoadConfig CabalLoader

HasConfig LoadConfig

Defined in Stack.Types.Config

Methods

configL :: Lens' LoadConfig Config

HasPlatform LoadConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' LoadConfig Platform

platformVariantL :: Lens' LoadConfig PlatformVariant

PackageIndex, IndexName & IndexLocation

data PackageIndex

Information on a single package index

Constructors

PackageIndex

Fields

• indexName :: !IndexName
• indexLocation :: !Text

  URL for the tarball or, in the case of Hackage Security, the root of the directory

• indexType :: !IndexType
• indexDownloadPrefix :: !Text

  URL prefix for downloading packages

• indexRequireHashes :: !Bool

  Require that hashes and package size information be available for packages in this index

Instances

Show PackageIndex

Defined in Stack.Types.PackageIndex

Methods

showsPrec :: Int -> PackageIndex -> ShowS

show :: PackageIndex -> String

showList :: [PackageIndex] -> ShowS

FromJSON (WithJSONWarnings PackageIndex)

Defined in Stack.Types.PackageIndex

Methods

parseJSON :: Value -> Parser (WithJSONWarnings PackageIndex)

parseJSONList :: Value -> Parser [WithJSONWarnings PackageIndex]

newtype IndexName

Unique name for a package index

Constructors

IndexName

Fields

• unIndexName :: ByteString

Instances

Eq IndexName

Defined in Stack.Types.PackageIndex

Methods

(==) :: IndexName -> IndexName -> Bool

(/=) :: IndexName -> IndexName -> Bool

Ord IndexName

Defined in Stack.Types.PackageIndex

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

Defined in Stack.Types.PackageIndex

Methods

showsPrec :: Int -> IndexName -> ShowS

show :: IndexName -> String

showList :: [IndexName] -> ShowS

Hashable IndexName

Defined in Stack.Types.PackageIndex

Methods

hashWithSalt :: Int -> IndexName -> Int

hash :: IndexName -> Int

ToJSON IndexName

Defined in Stack.Types.PackageIndex

Methods

toJSON :: IndexName -> Value

toEncoding :: IndexName -> Encoding

toJSONList :: [IndexName] -> Value

toEncodingList :: [IndexName] -> Encoding

FromJSON IndexName

Defined in Stack.Types.PackageIndex

Methods

parseJSON :: Value -> Parser IndexName

parseJSONList :: Value -> Parser [IndexName]

Store IndexName

Defined in Stack.Types.PackageIndex

Methods

size :: Size IndexName

poke :: IndexName -> Poke ()

peek :: Peek IndexName

indexNameText :: IndexName -> Text

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 :: ![PackageLocation Subdirs]

  Packages which are actually part of the project (as opposed to dependencies).

  NOTE Stack has always allowed these packages to be any kind of package location, but in reality only PLFilePath really makes sense. We could consider replacing [PackageLocation] with [FilePath] to properly enforce this idea, though it will slightly break backwards compatibility if someone really did want to treat such things as non-deps.

• projectDependencies :: ![PackageLocationIndex Subdirs]

  Dependencies defined within the stack.yaml file, to be applied on top of the snapshot.

• projectFlags :: !(Map PackageName (Map FlagName Bool))

  Flags to be applied on top of the snapshot flags.

• projectResolver :: !Resolver

  How we resolve which SnapshotDef to use

• projectCompiler :: !(Maybe (CompilerVersion CVWanted))

  When specified, overrides which compiler to use

• projectExtraPackageDBs :: ![FilePath]

Instances

Show Project

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> Project -> ShowS

show :: Project -> String

showList :: [Project] -> ShowS

ToJSON Project

Defined in Stack.Types.Config

Methods

toJSON :: Project -> Value

toEncoding :: Project -> Encoding

toJSONList :: [Project] -> Value

toEncodingList :: [Project] -> Encoding

data ProjectAndConfigMonoid

Constructors

ProjectAndConfigMonoid !Project !ConfigMonoid

parseProjectAndConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ProjectAndConfigMonoid)

PvpBounds

data PvpBounds

Constructors

PvpBounds

Fields

• pbType :: !PvpBoundsType
• pbAsRevision :: !Bool

Instances

Eq PvpBounds

Defined in Stack.Types.Config

Methods

(==) :: PvpBounds -> PvpBounds -> Bool

(/=) :: PvpBounds -> PvpBounds -> Bool

Ord PvpBounds

Defined in Stack.Types.Config

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

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS PvpBounds

readList :: ReadS [PvpBounds]

readPrec :: ReadPrec PvpBounds

readListPrec :: ReadPrec [PvpBounds]

Show PvpBounds

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> PvpBounds -> ShowS

show :: PvpBounds -> String

showList :: [PvpBounds] -> ShowS

ToJSON PvpBounds

Defined in Stack.Types.Config

Methods

toJSON :: PvpBounds -> Value

toEncoding :: PvpBounds -> Encoding

toJSONList :: [PvpBounds] -> Value

toEncodingList :: [PvpBounds] -> Encoding

FromJSON PvpBounds

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser PvpBounds

parseJSONList :: Value -> Parser [PvpBounds]

data PvpBoundsType

How PVP bounds should be added to .cabal files

Constructors

PvpBoundsNone

PvpBoundsUpper

PvpBoundsLower

PvpBoundsBoth

Instances

Bounded PvpBoundsType

Defined in Stack.Types.Config

Methods

minBound :: PvpBoundsType

maxBound :: PvpBoundsType

Enum PvpBoundsType

Defined in Stack.Types.Config

Methods

succ :: PvpBoundsType -> PvpBoundsType

pred :: PvpBoundsType -> PvpBoundsType

toEnum :: Int -> PvpBoundsType

fromEnum :: PvpBoundsType -> Int

enumFrom :: PvpBoundsType -> [PvpBoundsType]

enumFromThen :: PvpBoundsType -> PvpBoundsType -> [PvpBoundsType]

enumFromTo :: PvpBoundsType -> PvpBoundsType -> [PvpBoundsType]

enumFromThenTo :: PvpBoundsType -> PvpBoundsType -> PvpBoundsType -> [PvpBoundsType]

Eq PvpBoundsType

Defined in Stack.Types.Config

Methods

(==) :: PvpBoundsType -> PvpBoundsType -> Bool

(/=) :: PvpBoundsType -> PvpBoundsType -> Bool

Ord PvpBoundsType

Defined in Stack.Types.Config

Methods

compare :: PvpBoundsType -> PvpBoundsType -> Ordering

(<) :: PvpBoundsType -> PvpBoundsType -> Bool

(<=) :: PvpBoundsType -> PvpBoundsType -> Bool

(>) :: PvpBoundsType -> PvpBoundsType -> Bool

(>=) :: PvpBoundsType -> PvpBoundsType -> Bool

max :: PvpBoundsType -> PvpBoundsType -> PvpBoundsType

min :: PvpBoundsType -> PvpBoundsType -> PvpBoundsType

Read PvpBoundsType

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS PvpBoundsType

readList :: ReadS [PvpBoundsType]

readPrec :: ReadPrec PvpBoundsType

readListPrec :: ReadPrec [PvpBoundsType]

Show PvpBoundsType

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> PvpBoundsType -> ShowS

show :: PvpBoundsType -> String

showList :: [PvpBoundsType] -> ShowS

parsePvpBounds :: Text -> Either String PvpBounds

ColorWhen

readColorWhen :: ReadM ColorWhen

SCM

data SCM

A software control system.

Constructors

Git

Instances

Show SCM

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> SCM -> ShowS

show :: SCM -> String

showList :: [SCM] -> ShowS

ToJSON SCM

Defined in Stack.Types.Config

Methods

toJSON :: SCM -> Value

toEncoding :: SCM -> Encoding

toJSONList :: [SCM] -> Value

toEncodingList :: [SCM] -> Encoding

FromJSON SCM

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser SCM

parseJSONList :: Value -> Parser [SCM]

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

configLoadedSnapshotCache :: (MonadThrow m, MonadReader env m, HasConfig env, HasGHCVariant env) => SnapshotDef -> GlobalInfoSource -> m (Path Abs File)

Where to store LoadedSnapshot caches

data GlobalInfoSource

Where do we get information on global packages for loading up a LoadedSnapshot?

Constructors

GISSnapshotHints

Accept the hints in the snapshot definition

GISCompiler (CompilerVersion CVActual)

Look up the actual information in the installed compiler

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

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

Installation root for compiler tools

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

Hoogle directory.

hoogleDatabasePath :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs File)

Get the hoogle database path.

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

Package database for installing dependencies into

packageDatabaseExtra :: (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, HasEnvConfig env, MonadThrow m) => m (Path Rel Dir)

Relative directory for the platform and GHC identifier

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

Relative directory for the platform and GHC identifier without GHC bindist build

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.

shaPath :: (IsPath Rel t, MonadThrow m) => Path Rel t -> m (Path Rel t)

shaPathForBytes :: (IsPath Rel t, MonadThrow m) => ByteString -> m (Path Rel t)

workDirL :: HasConfig env => Lens' env (Path Rel Dir)

".stack-work"

Command-specific types

Eval

data EvalOpts

Constructors

EvalOpts

Fields

• evalArg :: !String
• evalExtra :: !ExecOptsExtra

Instances

Show EvalOpts

Defined in Stack.Types.Config

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

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> ExecOpts -> ShowS

show :: ExecOpts -> String

showList :: [ExecOpts] -> ShowS

data SpecialExecCmd

Constructors

ExecCmd String

ExecRun

ExecGhc

ExecRunGhc

Instances

Eq SpecialExecCmd

Defined in Stack.Types.Config

Methods

(==) :: SpecialExecCmd -> SpecialExecCmd -> Bool

(/=) :: SpecialExecCmd -> SpecialExecCmd -> Bool

Show SpecialExecCmd

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> SpecialExecCmd -> ShowS

show :: SpecialExecCmd -> String

showList :: [SpecialExecCmd] -> ShowS

data ExecOptsExtra

Constructors

ExecOptsPlain

ExecOptsEmbellished

Fields

• eoEnvSettings :: !EnvSettings
• eoPackages :: ![String]
• eoRtsOptions :: ![String]
• eoCwd :: !(Maybe FilePath)

Instances

Show ExecOptsExtra

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> ExecOptsExtra -> ShowS

show :: ExecOptsExtra -> String

showList :: [ExecOptsExtra] -> ShowS

Setup

data DownloadInfo

Build of the compiler distribution (e.g. standard, gmp4, tinfo6) | Information for a file to download.

Constructors

DownloadInfo

Fields

• downloadInfoUrl :: Text

  URL or absolute file path

• downloadInfoContentLength :: Maybe Int
• downloadInfoSha1 :: Maybe ByteString
• downloadInfoSha256 :: Maybe ByteString

Instances

Show DownloadInfo

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> DownloadInfo -> ShowS

show :: DownloadInfo -> String

showList :: [DownloadInfo] -> ShowS

FromJSON (WithJSONWarnings DownloadInfo)

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser (WithJSONWarnings DownloadInfo)

parseJSONList :: Value -> Parser [WithJSONWarnings DownloadInfo]

data VersionedDownloadInfo

Constructors

VersionedDownloadInfo

Fields

• vdiVersion :: Version
• vdiDownloadInfo :: DownloadInfo

Instances

Show VersionedDownloadInfo

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> VersionedDownloadInfo -> ShowS

show :: VersionedDownloadInfo -> String

showList :: [VersionedDownloadInfo] -> ShowS

FromJSON (WithJSONWarnings VersionedDownloadInfo)

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser (WithJSONWarnings VersionedDownloadInfo)

parseJSONList :: Value -> Parser [WithJSONWarnings VersionedDownloadInfo]

data GHCDownloadInfo

Constructors

GHCDownloadInfo

Fields

• gdiConfigureOpts :: [Text]
• gdiConfigureEnv :: Map Text Text
• gdiDownloadInfo :: DownloadInfo

Instances

Show GHCDownloadInfo

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> GHCDownloadInfo -> ShowS

show :: GHCDownloadInfo -> String

showList :: [GHCDownloadInfo] -> ShowS

FromJSON (WithJSONWarnings GHCDownloadInfo)

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser (WithJSONWarnings GHCDownloadInfo)

parseJSONList :: Value -> Parser [WithJSONWarnings GHCDownloadInfo]

data SetupInfo

Constructors

SetupInfo

Fields

• siSevenzExe :: Maybe DownloadInfo
• siSevenzDll :: Maybe DownloadInfo
• siMsys2 :: Map Text VersionedDownloadInfo
• siGHCs :: Map Text (Map Version GHCDownloadInfo)
• siGHCJSs :: Map Text (Map (CompilerVersion CVActual) DownloadInfo)
• siStack :: Map Text (Map Version DownloadInfo)

Instances

Show SetupInfo

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> SetupInfo -> ShowS

show :: SetupInfo -> String

showList :: [SetupInfo] -> ShowS

Semigroup SetupInfo

For siGHCs and siGHCJSs fields maps are deeply merged. For all fields the values from the last SetupInfo win.

Defined in Stack.Types.Config

Methods

(<>) :: SetupInfo -> SetupInfo -> SetupInfo

sconcat :: NonEmpty SetupInfo -> SetupInfo

stimes :: Integral b => b -> SetupInfo -> SetupInfo

Monoid SetupInfo

Defined in Stack.Types.Config

Methods

mempty :: SetupInfo

mappend :: SetupInfo -> SetupInfo -> SetupInfo

mconcat :: [SetupInfo] -> SetupInfo

FromJSON (WithJSONWarnings SetupInfo)

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser (WithJSONWarnings SetupInfo)

parseJSONList :: Value -> Parser [WithJSONWarnings SetupInfo]

data SetupInfoLocation

Remote or inline SetupInfo

Constructors

SetupInfoFileOrURL String

SetupInfoInline SetupInfo

Instances

Show SetupInfoLocation

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> SetupInfoLocation -> ShowS

show :: SetupInfoLocation -> String

showList :: [SetupInfoLocation] -> ShowS

FromJSON (WithJSONWarnings SetupInfoLocation)

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser (WithJSONWarnings SetupInfoLocation)

parseJSONList :: Value -> Parser [WithJSONWarnings SetupInfoLocation]

Docker entrypoint

newtype 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

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS DockerEntrypoint

readList :: ReadS [DockerEntrypoint]

readPrec :: ReadPrec DockerEntrypoint

readListPrec :: ReadPrec [DockerEntrypoint]

Show DockerEntrypoint

Defined in Stack.Types.Config

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

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS DockerUser

readList :: ReadS [DockerUser]

readPrec :: ReadPrec DockerUser

readListPrec :: ReadPrec [DockerUser]

Show DockerUser

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> DockerUser -> ShowS

show :: DockerUser -> String

showList :: [DockerUser] -> ShowS

module Stack.Types.Config.Build

Lens helpers

wantedCompilerVersionL :: HasBuildConfig s => Getting r s (CompilerVersion CVWanted)

The compiler specified by the SnapshotDef. This may be different from the actual compiler used!

actualCompilerVersionL :: HasEnvConfig s => Lens' s (CompilerVersion CVActual)

The version of the compiler which will actually be used. May be different than that specified in the SnapshotDef and returned by wantedCompilerVersionL.

buildOptsL :: HasConfig s => Lens' s BuildOpts

globalOptsL :: Lens' GlobalOpts ConfigMonoid

buildOptsInstallExesL :: Lens' BuildOpts Bool

buildOptsMonoidHaddockL :: Lens' BuildOptsMonoid (Maybe Bool)

buildOptsMonoidTestsL :: Lens' BuildOptsMonoid (Maybe Bool)

buildOptsMonoidBenchmarksL :: Lens' BuildOptsMonoid (Maybe Bool)

buildOptsMonoidInstallExesL :: Lens' BuildOptsMonoid (Maybe Bool)

buildOptsHaddockL :: Lens' BuildOpts Bool

globalOptsBuildOptsMonoidL :: Lens' GlobalOpts BuildOptsMonoid

stackRootL :: HasCabalLoader s => Lens' s (Path Abs Dir)

configUrlsL :: HasConfig env => Lens' env Urls

cabalVersionL :: HasEnvConfig env => Lens' env Version

whichCompilerL :: Getting r (CompilerVersion a) WhichCompiler

envOverrideSettingsL :: HasConfig env => Lens' env (EnvSettings -> IO ProcessContext)

loadedSnapshotL :: HasEnvConfig env => Lens' env LoadedSnapshot

globalHintsL :: HasBuildConfig s => Getting r s (Map PackageName (Maybe Version))

shouldForceGhcColorFlag :: (HasRunner env, HasEnvConfig env) => RIO env Bool

appropriateGhcColorFlag :: (HasRunner env, HasEnvConfig env) => RIO env (Maybe String)

Lens reexport

view :: MonadReader s m => Getting a s a -> m a

to :: (s -> a) -> SimpleGetter s a

to creates a getter from any function:

a ^. to f = f a

It's most useful in chains, because it lets you mix lenses and ordinary functions. Suppose you have a record which comes from some third-party library and doesn't have any lens accessors. You want to do something like this:

value ^. _1 . field . at 2

However, field isn't a getter, and you have to do this instead:

field (value ^. _1) ^. at 2

but now value is in the middle and it's hard to read the resulting code. A variant with to is prettier and more readable:

value ^. _1 . to field . at 2