Safe Haskell	None
Language	Haskell2010

Stack.Types.Config

Contents

Main configuration types and classes
Details
Paths
Command-specific types

Description

The Config type.

Synopsis

Main configuration types and classes

HasPlatform & HasStackRoot

class HasPlatform env where Source

Class for environment values which have a Platform

Minimal complete definition

Nothing

Methods

getPlatform :: env -> Platform Source

getPlatformVariant :: env -> PlatformVariant Source

Instances

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
HasStackRoot BuildConfig Source
HasStackRoot Config Source
HasStackRoot MiniConfig Source
HasStackRoot config => HasStackRoot (Env config) Source

data PlatformVariant Source

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

Constructors

PlatformVariantNone
PlatformVariant String

Instances

HasPlatform (Platform, PlatformVariant) Source

Config & HasConfig

data Config Source

The top-level Stackage configuration.

Constructors

Config

Fields

configStackRoot :: !(Path Abs Dir)

~/.stack more often than not

configWorkDir :: !(Path Rel Dir)

this allows to override .stack-work directory

configUserConfigPath :: !(Path Abs File)

Path to user configuration file (usually ~.stackconfig.yaml)

configBuild :: !BuildOpts

Build configuration

configDocker :: !DockerOpts

Docker configuration

configNix :: !NixOpts

Execution environment (e.g nix-shell) configuration

configEnvOverride :: !(EnvSettings -> IO EnvOverride)

Environment variables to be passed to external tools

configLocalProgramsBase :: !(Path Abs Dir)

Non-platform-specific path containing local installations

configLocalPrograms :: !(Path Abs Dir)

Path containing local installations (mainly GHC)

configConnectionCount :: !Int

How many concurrent connections are allowed when downloading

configHideTHLoading :: !Bool

Hide the Template Haskell "Loading package ..." messages from the console

configPlatform :: !Platform

The platform we're building for, used in many directory names

configPlatformVariant :: !PlatformVariant

Variant of the platform, also used in directory names

configGHCVariant0 :: !(Maybe GHCVariant)

The variant of GHC requested by the user. In most cases, use BuildConfig or MiniConfigs version instead, which will have an auto-detected default.

configUrls :: !Urls

URLs for other files used by stack. TODO: Better document e.g. The latest snapshot file. A build plan name (e.g. lts5.9.yaml) is appended when downloading the build plan actually.

configPackageIndices :: ![PackageIndex]

Information on package indices. This is left biased, meaning that packages in an earlier index will shadow those in a later index.

Warning: if you override packages in an index vs what's available upstream, you may correct your compiled snapshots, as different projects may have different definitions of what pkg-ver means! This feature is primarily intended for adding local packages, not overriding. Overriding is better accomplished by adding to your list of packages.

Note that indices specified in a later config file will override previous indices, not extend them.

Using an assoc list instead of a Map to keep track of priority

configSystemGHC :: !Bool

Should we use the system-installed GHC (on the PATH) if available? Can be overridden by command line options.

configInstallGHC :: !Bool

Should we automatically install GHC if missing or the wrong version is available? Can be overridden by command line options.

configSkipGHCCheck :: !Bool

Don't bother checking the GHC version or architecture.

configSkipMsys :: !Bool

On Windows: don't use a locally installed MSYS

configCompilerCheck :: !VersionCheck

Specifies which versions of the compiler are acceptable.

configLocalBin :: !(Path Abs Dir)

Directory we should install executables into

configRequireStackVersion :: !VersionRange

Require a version of stack within this range.

configJobs :: !Int

How many concurrent jobs to run, defaults to number of capabilities

configExtraIncludeDirs :: !(Set Text)

-extra-include-dirs arguments

configExtraLibDirs :: !(Set Text)

-extra-lib-dirs arguments

configConcurrentTests :: !Bool

Run test suites concurrently

configImage :: !ImageOpts

configTemplateParams :: !(Map Text Text)

Parameters for templates.

configScmInit :: !(Maybe SCM)

Initialize SCM (e.g. git) when creating new projects.

configGhcOptions :: !GhcOptions

Additional GHC options to apply to either all packages (Nothing) or a specific package (Just).

configSetupInfoLocations :: ![SetupInfoLocation]

Additional SetupInfo (inline or remote) to use to find tools.

configPvpBounds :: !PvpBounds

How PVP upper bounds should be added to packages

configModifyCodePage :: !Bool

Force the code page to UTF-8 on Windows

configExplicitSetupDeps :: !(Map (Maybe PackageName) Bool)

See explicitSetupDeps. Nothing provides the default value.

configRebuildGhcOptions :: !Bool

Rebuild on GHC options changes

configApplyGhcOptions :: !ApplyGhcOptions

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

configAllowNewer :: !Bool

Ignore version ranges in .cabal files. Funny naming chosen to match cabal.

configDefaultTemplate :: !(Maybe TemplateName)

The default template to use when none is specified. (If Nothing, the default default is used.)

configAllowDifferentUser :: !Bool

Allow users other than the stack root owner to use the stack installation.

configPackageCaches :: !(IORef (Maybe (Map PackageIdentifier (PackageIndex, PackageCache))))

In memory cache of hackage index.

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

Instances

HasConfig Config Source
HasPlatform Config Source
HasStackRoot Config 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
HasConfig BuildConfig Source
HasConfig Config Source
HasConfig MiniConfig Source
HasConfig config => HasConfig (Env config) Source

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

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

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

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

BuildConfig & HasBuildConfig

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 :: !LoadedResolver

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

bcWantedMiniBuildPlan :: !MiniBuildPlan

Compiler version wanted for this build

bcPackageEntries :: ![PackageEntry]

Local packages

bcExtraDeps :: !(Map PackageName Version)

Extra dependencies specified in configuration.

These dependencies will not be installed to a shared location, and will override packages provided by the resolver.

bcExtraPackageDBs :: ![Path Abs Dir]

Extra package databases

bcStackYaml :: !(Path Abs File)

Location of the stack.yaml file.

Note: if the STACK_YAML environment variable is used, this may be different from bcRoot / "stack.yaml"

bcFlags :: !PackageFlags

Per-package flag overrides

bcImplicitGlobal :: !Bool

Are we loading from the implicit global stack.yaml? This is useful for providing better error messages.

bcGHCVariant :: !GHCVariant

The variant of GHC used to select a GHC bindist.

Instances

HasBuildConfig BuildConfig Source
HasConfig BuildConfig Source
HasGHCVariant BuildConfig Source
HasPlatform BuildConfig Source
HasStackRoot BuildConfig Source

bcRoot :: BuildConfig -> Path Abs Dir Source

Directory containing the project's stack.yaml file

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

"bcRoot/.stack-work"

bcWantedCompiler :: BuildConfig -> CompilerVersion 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
HasBuildConfig BuildConfig Source
HasBuildConfig config => HasBuildConfig (Env config) Source

GHCVariant & HasGHCVariant

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
FromJSON GHCVariant Source
HasGHCVariant 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.

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
HasGHCVariant EnvConfig Source
HasGHCVariant BuildConfig Source
HasGHCVariant MiniConfig Source
HasGHCVariant config => HasGHCVariant (Env config) Source

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

Directory containing snapshots

EnvConfig & HasEnvConfig

data EnvConfig Source

Configuration after the environment has been setup.

Constructors

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

Instances

HasBuildConfig EnvConfig Source
HasConfig EnvConfig Source
HasGHCVariant EnvConfig Source
HasPlatform EnvConfig Source
HasStackRoot EnvConfig Source
HasEnvConfig EnvConfig Source

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

Methods

getEnvConfig :: r -> EnvConfig Source

Instances

HasEnvConfig EnvConfig Source
HasEnvConfig config => HasEnvConfig (Env config) Source

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

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

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

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

Details

ApplyGhcOptions

data ApplyGhcOptions Source

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

Constructors

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

ConfigException

data ConfigException Source

Instances

Show ConfigException Source
Exception ConfigException Source

WhichSolverCmd

data WhichSolverCmd Source

Constructors

IsInitCmd
IsSolverCmd
IsNewCmd

ConfigMonoid

data ConfigMonoid Source

Constructors

ConfigMonoid

Fields

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

Instances

Show ConfigMonoid Source
Generic ConfigMonoid Source
Monoid ConfigMonoid Source
FromJSON (WithJSONWarnings ConfigMonoid) Source
type Rep ConfigMonoid Source

EnvSettings

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
Ord EnvSettings Source
Show EnvSettings Source

minimalEnvSettings :: EnvSettings Source

GlobalOpts & GlobalOptsMonoid

data GlobalOpts Source

Parsed global command-line options.

Constructors

GlobalOpts

Fields

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

Instances

Show GlobalOpts Source

data GlobalOptsMonoid Source

Parsed global command-line options monoid.

Constructors

GlobalOptsMonoid

Fields

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

Instances

Show GlobalOptsMonoid Source
Generic GlobalOptsMonoid Source
Monoid GlobalOptsMonoid Source
type Rep GlobalOptsMonoid Source

defaultLogLevel :: LogLevel Source

Default logging level should be something useful but not crazy.

LoadConfig

data LoadConfig m Source

Value returned by loadConfig.

Constructors

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

PackageEntry & PackageLocation

data PackageEntry Source

Constructors

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

Instances

Show PackageEntry Source
ToJSON PackageEntry Source
FromJSON (WithJSONWarnings PackageEntry) Source

type TreatLikeExtraDep = Bool Source

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

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

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

data PackageLocation 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`.
PLRemote Text RemotePackageType	URL and further details

Instances

Show PackageLocation Source
ToJSON PackageLocation Source
FromJSON (WithJSONWarnings PackageLocation) Source

data RemotePackageType Source

Constructors

RPTHttp
RPTGit Text	Commit
RPTHg Text	Commit

Instances

Show RemotePackageType Source

PackageIndex, IndexName & IndexLocation

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
FromJSON (WithJSONWarnings PackageIndex) Source

newtype IndexName Source

Unique name for a package index

Constructors

IndexName
Fields unIndexName :: ByteString

Instances

Eq IndexName Source
Ord IndexName Source
Show IndexName Source
Binary IndexName Source
ToJSON IndexName Source
FromJSON IndexName Source
Hashable IndexName Source

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

Location of the 00-index.tar file

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

Location of the 00-index.cache file

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

Location of the 00-index.tar.gz file

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

Root for a specific package index

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

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

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

Location of a package tarball

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
Ord IndexLocation Source
Show IndexLocation Source

Project & ProjectAndConfigMonoid

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

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

Instances

Show Project Source
ToJSON Project Source

data ProjectAndConfigMonoid Source

Constructors

ProjectAndConfigMonoid !Project !ConfigMonoid

Instances

FromJSON (WithJSONWarnings ProjectAndConfigMonoid) Source

PvpBounds

data PvpBounds Source

How PVP bounds should be added to .cabal files

Constructors

PvpBoundsNone
PvpBoundsUpper
PvpBoundsLower
PvpBoundsBoth

Instances

Bounded PvpBounds Source
Enum PvpBounds Source
Eq PvpBounds Source
Ord PvpBounds Source
Read PvpBounds Source
Show PvpBounds Source
ToJSON PvpBounds Source
FromJSON PvpBounds Source

parsePvpBounds :: Text -> Either String PvpBounds Source

Resolver & AbstractResolver

type Resolver = ResolverThat's NotLoaded Source

type LoadedResolver = ResolverThat's Loaded Source

data ResolverThat's l where Source

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

Constructors

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

Instances

Show (ResolverThat's k) Source
ToJSON (ResolverThat's k) Source
FromJSON (WithJSONWarnings (CustomSnapshot, Maybe Resolver)) Source

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

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

resolverDirName :: LoadedResolver -> Text Source

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

resolverName :: ResolverThat's l -> Text Source

Convert a Resolver into its Text representation for human presentation.

customResolverHash :: LoadedResolver -> Maybe SnapshotHash Source

toResolverNotLoaded :: LoadedResolver -> Resolver Source

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

SCM

data SCM Source

A software control system.

Constructors

Git

Instances

Show SCM Source
ToJSON SCM Source
FromJSON SCM Source

CustomSnapshot

data CustomSnapshot Source

Constructors

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

Instances

FromJSON (WithJSONWarnings (CustomSnapshot, Maybe Resolver)) Source

GhcOptions

newtype GhcOptions Source

Constructors

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

Instances

Show GhcOptions Source
FromJSON GhcOptions Source
Monoid GhcOptions Source

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

PackageFlags

newtype PackageFlags Source

Constructors

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

Instances

Show PackageFlags Source
ToJSON PackageFlags Source
FromJSON PackageFlags Source
Monoid PackageFlags Source

Paths

bindirSuffix :: Path Rel Dir Source

Suffix applied to an installation root to get the bin dir

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

File containing the installed cache, see Stack.PackageDump

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

Where to store mini build plan caches

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

Per-project work dir

docDirSuffix :: Path Rel Dir Source

Suffix applied to an installation root to get the doc dir

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

Directory for holding flag cache information

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

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

Where HPC reports and tix files get stored.

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

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

Package database for installing dependencies into

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

Extra package databases

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

Package database for installing local packages into

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

Relative directory for the platform identifier

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

Relative directory for the platform identifier

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

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

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

".stack-work"

Command-specific types

Eval

data EvalOpts Source

Constructors

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

Instances

Show EvalOpts Source

Exec

data ExecOpts Source

Constructors

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

Instances

Show ExecOpts Source

data SpecialExecCmd Source

Constructors

ExecCmd String
ExecGhc
ExecRunGhc

Instances

Eq SpecialExecCmd Source
Show SpecialExecCmd Source

data ExecOptsExtra Source

Constructors

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

Instances

Show ExecOptsExtra Source

Setup

data DownloadInfo Source

Information for a file to download.

Constructors

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

Instances

Show DownloadInfo Source
FromJSON (WithJSONWarnings DownloadInfo) Source

data VersionedDownloadInfo Source

Constructors

VersionedDownloadInfo
Fields vdiVersion :: Version vdiDownloadInfo :: DownloadInfo

Instances

Show VersionedDownloadInfo Source
FromJSON (WithJSONWarnings VersionedDownloadInfo) Source

data SetupInfo Source

Constructors

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

Instances

Show SetupInfo Source
Monoid SetupInfo Source	For `siGHCs` and `siGHCJSs` fields maps are deeply merged. For all fields the values from the last `SetupInfo` win.
FromJSON (WithJSONWarnings SetupInfo) Source

data SetupInfoLocation Source

Remote or inline SetupInfo

Constructors

SetupInfoFileOrURL String
SetupInfoInline SetupInfo

Instances

Show SetupInfoLocation Source
FromJSON (WithJSONWarnings SetupInfoLocation) Source

Docker entrypoint

data DockerEntrypoint Source

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 Source
Show DockerEntrypoint Source

data DockerUser Source

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 Source
Show DockerUser Source

Bounded ApplyGhcOptions Source
Enum ApplyGhcOptions Source
Eq ApplyGhcOptions Source
Ord ApplyGhcOptions Source
Read ApplyGhcOptions Source
Show ApplyGhcOptions Source
FromJSON ApplyGhcOptions Source

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