stack-1.7.1: The Haskell Tool Stack

Safe HaskellNone
LanguageHaskell2010

Stack.Types.Config

Contents

Description

The Config type.

Synopsis

Main configuration types and classes

HasPlatform & HasStackRoot

data PlatformVariant #

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

Config & HasConfig

data Config #

The top-level Stackage configuration.

Constructors

Config 

Fields

Instances
HasProcessContext Config # 
Instance details

Defined in Stack.Types.Config

HasLogFunc Config # 
Instance details

Defined in Stack.Types.Config

HasRunner Config # 
Instance details

Defined in Stack.Types.Config

HasCabalLoader Config # 
Instance details

Defined in Stack.Types.Config

HasConfig Config # 
Instance details

Defined in Stack.Types.Config

HasPlatform Config # 
Instance details

Defined in Stack.Types.Config

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

Class for environment values that can provide a Config.

Methods

configL :: Lens' env Config #

configL :: HasBuildConfig env => Lens' env Config #

Instances
HasConfig LoadConfig # 
Instance details

Defined in Stack.Types.Config

HasConfig EnvConfig # 
Instance details

Defined in Stack.Types.Config

HasConfig BuildConfig # 
Instance details

Defined in Stack.Types.Config

HasConfig Config # 
Instance details

Defined in Stack.Types.Config

HasConfig MiniConfig # 
Instance details

Defined in Stack.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

data LocalPackageView #

A view of a local package needed for resolving components

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

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

Directory containing the project's stack.yaml file

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

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

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

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

Minimal complete definition

envConfigL

Methods

envConfigL :: Lens' env EnvConfig #

Instances
HasEnvConfig EnvConfig # 
Instance details

Defined in Stack.Types.Config

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 # 
Instance details

Defined in Stack.Types.Config

Enum ApplyGhcOptions # 
Instance details

Defined in Stack.Types.Config

Eq ApplyGhcOptions # 
Instance details

Defined in Stack.Types.Config

Ord ApplyGhcOptions # 
Instance details

Defined in Stack.Types.Config

Read ApplyGhcOptions # 
Instance details

Defined in Stack.Types.Config

Show ApplyGhcOptions # 
Instance details

Defined in Stack.Types.Config

FromJSON ApplyGhcOptions # 
Instance details

Defined in Stack.Types.Config

ConfigException

WhichSolverCmd

ConfigMonoid

data ConfigMonoid #

Constructors

ConfigMonoid 

Fields

Instances
Show ConfigMonoid # 
Instance details

Defined in Stack.Types.Config

Generic ConfigMonoid # 
Instance details

Defined in Stack.Types.Config

Associated Types

type Rep ConfigMonoid :: * -> * #

Semigroup ConfigMonoid # 
Instance details

Defined in Stack.Types.Config

Monoid ConfigMonoid # 
Instance details

Defined in Stack.Types.Config

type Rep ConfigMonoid # 
Instance details

Defined in Stack.Types.Config

type Rep ConfigMonoid = D1 (MetaData "ConfigMonoid" "Stack.Types.Config" "stack-1.7.1-79VQHXRBDVUIQMpSmzqhhb" 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 (Map PackageName [Text])))) :*: (S1 (MetaSel (Just "configMonoidGhcOptionsByCat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map ApplyGhcOptions [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 "configMonoidIgnoreRevisionMismatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))))))))

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 # 
Instance details

Defined in Stack.Types.Config

Enum DumpLogs # 
Instance details

Defined in Stack.Types.Config

Eq DumpLogs # 
Instance details

Defined in Stack.Types.Config

Ord DumpLogs # 
Instance details

Defined in Stack.Types.Config

Read DumpLogs # 
Instance details

Defined in Stack.Types.Config

Show DumpLogs # 
Instance details

Defined in Stack.Types.Config

FromJSON DumpLogs # 
Instance details

Defined in Stack.Types.Config

EnvSettings

data EnvSettings #

Controls which version of the environment is used

Constructors

EnvSettings 

Fields

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

Instances
Show GlobalOpts # 
Instance details

Defined in Stack.Types.Config

data GlobalOptsMonoid #

Parsed global command-line options monoid.

Constructors

GlobalOptsMonoid 

Fields

Instances
Show GlobalOptsMonoid # 
Instance details

Defined in Stack.Types.Config

Generic GlobalOptsMonoid # 
Instance details

Defined in Stack.Types.Config

Associated Types

type Rep GlobalOptsMonoid :: * -> * #

Semigroup GlobalOptsMonoid # 
Instance details

Defined in Stack.Types.Config

Monoid GlobalOptsMonoid # 
Instance details

Defined in Stack.Types.Config

type Rep GlobalOptsMonoid # 
Instance details

Defined in Stack.Types.Config

type Rep GlobalOptsMonoid = D1 (MetaData "GlobalOptsMonoid" "Stack.Types.Config" "stack-1.7.1-79VQHXRBDVUIQMpSmzqhhb" 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 # 
Instance details

Defined in Stack.Types.Config

Methods

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

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

Foldable StackYamlLoc # 
Instance details

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 # 
Instance details

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) # 
Instance details

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

PackageIndex, IndexName & IndexLocation

data PackageIndex #

Information on a single package index

Constructors

PackageIndex 

Fields

newtype IndexName #

Unique name for a package index

Constructors

IndexName 

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

Instances
Show Project # 
Instance details

Defined in Stack.Types.Config

ToJSON Project # 
Instance details

Defined in Stack.Types.Config

PvpBounds

data PvpBoundsType #

How PVP bounds should be added to .cabal files

Instances
Bounded PvpBoundsType # 
Instance details

Defined in Stack.Types.Config

Enum PvpBoundsType # 
Instance details

Defined in Stack.Types.Config

Eq PvpBoundsType # 
Instance details

Defined in Stack.Types.Config

Ord PvpBoundsType # 
Instance details

Defined in Stack.Types.Config

Read PvpBoundsType # 
Instance details

Defined in Stack.Types.Config

Show PvpBoundsType # 
Instance details

Defined in Stack.Types.Config

ColorWhen

SCM

data SCM #

A software control system.

Constructors

Git 
Instances
Show SCM # 
Instance details

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> SCM -> ShowS #

show :: SCM -> String #

showList :: [SCM] -> ShowS #

ToJSON SCM # 
Instance details

Defined in Stack.Types.Config

FromJSON SCM # 
Instance details

Defined in Stack.Types.Config

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

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 
Instances
Show EvalOpts # 
Instance details

Defined in Stack.Types.Config

Exec

data ExecOpts #

Constructors

ExecOpts 
Instances
Show ExecOpts # 
Instance details

Defined in Stack.Types.Config

Setup

data DownloadInfo #

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

data SetupInfo #

Instances
Show SetupInfo # 
Instance details

Defined in Stack.Types.Config

Semigroup SetupInfo #

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

Instance details

Defined in Stack.Types.Config

Monoid SetupInfo # 
Instance details

Defined in Stack.Types.Config

FromJSON (WithJSONWarnings SetupInfo) # 
Instance details

Defined in Stack.Types.Config

Docker entrypoint

newtype DockerEntrypoint #

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

Constructors

DockerEntrypoint 

Fields

data DockerUser #

Docker host user info

Constructors

DockerUser 

Fields

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.

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