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

Runner

class (HasProcessContext env, HasLogFunc env) => HasRunner env where

Class for environment values which have a Runner.

Methods

runnerL :: Lens' env Runner

Instances

HasRunner EnvConfig

Defined in Stack.Types.Config

Methods

runnerL :: Lens' EnvConfig Runner

HasRunner BuildConfig

Defined in Stack.Types.Config

Methods

runnerL :: Lens' BuildConfig Runner

HasRunner Config

Defined in Stack.Types.Config

Methods

runnerL :: Lens' Config Runner

HasRunner Runner

Defined in Stack.Types.Config

Methods

runnerL :: Lens' Runner Runner

data Runner

The base environment that almost everything in Stack runs in, based off of parsing command line options in GlobalOpts. Provides logging and process execution.

Constructors

Runner

Fields

• runnerGlobalOpts :: !GlobalOpts
• runnerUseColor :: !Bool
• runnerLogFunc :: !LogFunc
• runnerTermWidth :: !Int
• runnerProcessContext :: !ProcessContext

Instances

HasProcessContext Runner

Defined in Stack.Types.Config

Methods

processContextL :: Lens' Runner ProcessContext

HasLogFunc Runner

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' Runner LogFunc

HasTerm Runner

Defined in Stack.Types.Config

Methods

useColorL :: Lens' Runner Bool

termWidthL :: Lens' Runner Int

HasStylesUpdate Runner

Defined in Stack.Types.Config

Methods

stylesUpdateL :: Lens' Runner StylesUpdate

HasRunner Runner

Defined in Stack.Types.Config

Methods

runnerL :: Lens' Runner Runner

data ColorWhen

Constructors

ColorNever

ColorAlways

ColorAuto

Instances

Eq ColorWhen

Defined in Stack.Types.Config

Methods

(==) :: ColorWhen -> ColorWhen -> Bool

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

Show ColorWhen

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> ColorWhen -> ShowS

show :: ColorWhen -> String

showList :: [ColorWhen] -> ShowS

Generic ColorWhen

Defined in Stack.Types.Config

Associated Types

type Rep ColorWhen :: Type -> Type

Methods

from :: ColorWhen -> Rep ColorWhen x

to :: Rep ColorWhen x -> ColorWhen

FromJSON ColorWhen

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser ColorWhen

parseJSONList :: Value -> Parser [ColorWhen]

type Rep ColorWhen

Defined in Stack.Types.Config

type Rep ColorWhen = D1 (MetaData "ColorWhen" "Stack.Types.Config" "stack-2.1.1.1-IcmSiv90ky67Jq7jcJ1Q2" False) (C1 (MetaCons "ColorNever" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ColorAlways" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ColorAuto" PrefixI False) (U1 :: Type -> Type)))

terminalL :: HasRunner env => Lens' env Bool

See globalTerminal

reExecL :: HasRunner env => SimpleGetter env Bool

See globalReExecVersion

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

• configGHCVariant :: !(Maybe GHCVariant)

  The variant of GHC requested by the user.

• configGHCBuild :: !(Maybe CompilerBuild)

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

• configLatestSnapshot :: !Text

  URL of a JSON file providing the latest LTS and Nightly snapshots.

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

• configCompilerRepository :: !CompilerRepository

  Specifies the repository containing the compiler sources

• 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

• configExtraIncludeDirs :: ![FilePath]
  • -extra-include-dirs arguments
• configExtraLibDirs :: ![FilePath]
  • -extra-lib-dirs arguments
• configConcurrentTests :: !Bool

  Run test suites concurrently

• 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

• configCabalConfigOpts :: !(Map CabalConfigKey [Text])

  Additional options to be passed to ./Setup.hs configure

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

• configProject :: !(ProjectConfig (Project, Path Abs File))

  Project information and stack.yaml file location

• 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
• configPantryConfig :: !PantryConfig
• configStackRoot :: !(Path Abs Dir)
• configResolver :: !(Maybe AbstractResolver)

  Any resolver override from the command line

• configStorage :: !Storage

  Database connection pool for Stack database

• configHideSourcePaths :: !Bool

  Enable GHC hiding source paths?

• configRecommendUpgrade :: !Bool

  Recommend a Stack upgrade?

Instances

HasPantryConfig Config

Defined in Stack.Types.Config

Methods

pantryConfigL :: Lens' Config PantryConfig

HasProcessContext Config

Defined in Stack.Types.Config

Methods

processContextL :: Lens' Config ProcessContext

HasLogFunc Config

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' Config LogFunc

HasTerm Config

Defined in Stack.Types.Config

Methods

useColorL :: Lens' Config Bool

termWidthL :: Lens' Config Int

HasStylesUpdate Config

Defined in Stack.Types.Config

Methods

stylesUpdateL :: Lens' Config StylesUpdate

HasConfig Config

Defined in Stack.Types.Config

Methods

configL :: Lens' Config Config

HasRunner Config

Defined in Stack.Types.Config

Methods

runnerL :: Lens' Config Runner

HasGHCVariant Config

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter Config GHCVariant

HasPlatform Config

Defined in Stack.Types.Config

Methods

platformL :: Lens' Config Platform

platformVariantL :: Lens' Config PlatformVariant

class (HasPlatform env, HasGHCVariant env, HasProcessContext env, HasPantryConfig env, HasTerm env, HasRunner 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 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

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

configProjectRoot :: Config -> Maybe (Path Abs Dir)

The project root directory, if in a project.

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
• bcSMWanted :: !SMWanted
• 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" if a different file name is used.

• bcCurator :: !(Maybe Curator)

Instances

HasPantryConfig BuildConfig

Defined in Stack.Types.Config

Methods

pantryConfigL :: Lens' BuildConfig PantryConfig

HasProcessContext BuildConfig

Defined in Stack.Types.Config

Methods

processContextL :: Lens' BuildConfig ProcessContext

HasLogFunc BuildConfig

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' BuildConfig LogFunc

HasTerm BuildConfig

Defined in Stack.Types.Config

Methods

useColorL :: Lens' BuildConfig Bool

termWidthL :: Lens' BuildConfig Int

HasStylesUpdate BuildConfig

Defined in Stack.Types.Config

Methods

stylesUpdateL :: Lens' BuildConfig StylesUpdate

HasBuildConfig BuildConfig

Defined in Stack.Types.Config

Methods

buildConfigL :: Lens' BuildConfig BuildConfig

HasConfig BuildConfig

Defined in Stack.Types.Config

Methods

configL :: Lens' BuildConfig Config

HasRunner BuildConfig

Defined in Stack.Types.Config

Methods

runnerL :: Lens' BuildConfig Runner

HasGHCVariant BuildConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter BuildConfig GHCVariant

HasPlatform BuildConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' BuildConfig Platform

platformVariantL :: Lens' BuildConfig PlatformVariant

data ProjectPackage

A view of a project package needed for resolving components

Constructors

ProjectPackage

Fields

• ppCommon :: !CommonPackage
• ppCabalFP :: !(Path Abs File)
• ppResolvedDir :: !(ResolvedPath Dir)

data DepPackage

A view of a dependency package, specified in stack.yaml

Constructors

DepPackage

Fields

• dpCommon :: !CommonPackage
• dpLocation :: !PackageLocation
• dpHidden :: !Bool

  Should the package be hidden after registering? Affects the script interpreter's module name import parser.

• dpFromSnapshot :: !FromSnapshot

  Needed to ignore bounds between snapshot packages See https://github.com/commercialhaskell/stackage/issues/3185

ppRoot :: ProjectPackage -> Path Abs Dir

Root directory for the given ProjectPackage

ppVersion :: MonadIO m => ProjectPackage -> m Version

Version for the given 'ProjectPackage

ppComponents :: MonadIO m => ProjectPackage -> m (Set NamedComponent)

All components available in the given ProjectPackage

ppGPD :: MonadIO m => ProjectPackage -> m GenericPackageDescription

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 :: SimpleGetter 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 :: SimpleGetter env GHCVariant

ghcVariantL :: HasConfig env => SimpleGetter env GHCVariant

Instances

HasGHCVariant GHCVariant

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter GHCVariant GHCVariant

HasGHCVariant EnvConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter EnvConfig GHCVariant

HasGHCVariant BuildConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter BuildConfig GHCVariant

HasGHCVariant Config

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter Config 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
• envConfigBuildOptsCLI :: !BuildOptsCLI
• envConfigSourceMap :: !SourceMap
• envConfigSourceMapHash :: !SourceMapHash
• envConfigCompilerPaths :: !CompilerPaths

Instances

HasPantryConfig EnvConfig

Defined in Stack.Types.Config

Methods

pantryConfigL :: Lens' EnvConfig PantryConfig

HasProcessContext EnvConfig

Defined in Stack.Types.Config

Methods

processContextL :: Lens' EnvConfig ProcessContext

HasLogFunc EnvConfig

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' EnvConfig LogFunc

HasTerm EnvConfig

Defined in Stack.Types.Config

Methods

useColorL :: Lens' EnvConfig Bool

termWidthL :: Lens' EnvConfig Int

HasStylesUpdate EnvConfig

Defined in Stack.Types.Config

Methods

stylesUpdateL :: Lens' EnvConfig StylesUpdate

HasSourceMap EnvConfig

Defined in Stack.Types.Config

Methods

sourceMapL :: Lens' EnvConfig SourceMap

HasCompiler EnvConfig

Defined in Stack.Types.Config

Methods

compilerPathsL :: SimpleGetter EnvConfig CompilerPaths

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

HasRunner EnvConfig

Defined in Stack.Types.Config

Methods

runnerL :: Lens' EnvConfig Runner

HasGHCVariant EnvConfig

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter EnvConfig GHCVariant

HasPlatform EnvConfig

Defined in Stack.Types.Config

Methods

platformL :: Lens' EnvConfig Platform

platformVariantL :: Lens' EnvConfig PlatformVariant

class HasSourceMap env where

Methods

sourceMapL :: Lens' env SourceMap

Instances

HasSourceMap EnvConfig

Defined in Stack.Types.Config

Methods

sourceMapL :: Lens' EnvConfig SourceMap

class (HasBuildConfig env, HasSourceMap env, HasCompiler env) => HasEnvConfig env where

Methods

envConfigL :: Lens' env EnvConfig

Instances

HasEnvConfig EnvConfig

Defined in Stack.Types.Config

Methods

envConfigL :: Lens' EnvConfig EnvConfig

getCompilerPath :: HasCompiler env => RIO env (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]

CabalConfigKey

data CabalConfigKey

Which packages do configure opts apply to?

Constructors

CCKTargets

See AGOTargets

CCKLocals

See AGOLocals

CCKEverything

See AGOEverything

CCKPackage !PackageName

A specific package

Instances

Eq CabalConfigKey

Defined in Stack.Types.Config

Methods

(==) :: CabalConfigKey -> CabalConfigKey -> Bool

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

Ord CabalConfigKey

Defined in Stack.Types.Config

Methods

compare :: CabalConfigKey -> CabalConfigKey -> Ordering

(<) :: CabalConfigKey -> CabalConfigKey -> Bool

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

(>) :: CabalConfigKey -> CabalConfigKey -> Bool

(>=) :: CabalConfigKey -> CabalConfigKey -> Bool

max :: CabalConfigKey -> CabalConfigKey -> CabalConfigKey

min :: CabalConfigKey -> CabalConfigKey -> CabalConfigKey

Read CabalConfigKey

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS CabalConfigKey

readList :: ReadS [CabalConfigKey]

readPrec :: ReadPrec CabalConfigKey

readListPrec :: ReadPrec [CabalConfigKey]

Show CabalConfigKey

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> CabalConfigKey -> ShowS

show :: CabalConfigKey -> String

showList :: [CabalConfigKey] -> ShowS

FromJSON CabalConfigKey

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser CabalConfigKey

parseJSONList :: Value -> Parser [CabalConfigKey]

FromJSONKey CabalConfigKey

Defined in Stack.Types.Config

Methods

fromJSONKey :: FromJSONKeyFunction CabalConfigKey

fromJSONKeyList :: FromJSONKeyFunction [CabalConfigKey]

ConfigException

data HpackExecutable

What to use for running hpack

Since: pantry-tmp-0.1.0.0

Constructors

HpackBundled

Compiled in library

HpackCommand !FilePath

Executable at the provided path

Instances

Eq HpackExecutable

Defined in Pantry.Types

Methods

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

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

Ord HpackExecutable

Defined in Pantry.Types

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 Pantry.Types

Methods

readsPrec :: Int -> ReadS HpackExecutable

readList :: ReadS [HpackExecutable]

readPrec :: ReadPrec HpackExecutable

readListPrec :: ReadPrec [HpackExecutable]

Show HpackExecutable

Defined in Pantry.Types

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 (NonEmpty SnapName)

ResolverMismatch !RawSnapshotLocation String

ResolverPartial !RawSnapshotLocation 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)

ManualGHCVariantSettingsAreIncompatibleWithSystemGHC

NixRequiresSystemGhc

NoResolverWhenUsingNoProject

DuplicateLocalPackageNames ![(PackageName, [PackageLocation])]

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

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

  See: configHideTHLoading

• configMonoidLatestSnapshot :: !(First Text)

  See: configLatestSnapshot

• configMonoidPackageIndices :: !(First [HackageSecurityConfig])

  See: picIndices

• configMonoidSystemGHC :: !(First Bool)

  See: configSystemGHC

• configMonoidInstallGHC :: !FirstTrue

  See: configInstallGHC

• configMonoidSkipGHCCheck :: !FirstFalse

  See: configSkipGHCCheck

• configMonoidSkipMsys :: !FirstFalse

  See: configSkipMsys

• configMonoidCompilerCheck :: !(First VersionCheck)

  See: configCompilerCheck

• configMonoidCompilerRepository :: !(First CompilerRepository)

  See: configCompilerRepository

• 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 :: ![FilePath]

  See: configExtraIncludeDirs

• configMonoidExtraLibDirs :: ![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

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

• configMonoidCabalConfigOpts :: !(MonoidMap CabalConfigKey (Dual [Text]))

  See configCabalConfigOpts.

• 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 :: !FirstTrue

  See configModifyCodePage

• configMonoidExplicitSetupDeps :: !(Map (Maybe PackageName) Bool)

  See configExplicitSetupDeps

• configMonoidRebuildGhcOptions :: !FirstFalse

  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

• configMonoidColorWhen :: !(First ColorWhen)

  When to use ANSI colors

• configMonoidStyles :: !StylesUpdate
• configMonoidHideSourcePaths :: !FirstTrue

  See configHideSourcePaths

• configMonoidRecommendUpgrade :: !FirstTrue

  See configRecommendUpgrade

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-2.1.1.1-IcmSiv90ky67Jq7jcJ1Q2" 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 FirstTrue) :*: (S1 (MetaSel (Just "configMonoidLatestSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Text)) :*: S1 (MetaSel (Just "configMonoidPackageIndices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First [HackageSecurityConfig])))) :*: (S1 (MetaSel (Just "configMonoidSystemGHC") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: (S1 (MetaSel (Just "configMonoidInstallGHC") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FirstTrue) :*: S1 (MetaSel (Just "configMonoidSkipGHCCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FirstFalse))))) :*: (((S1 (MetaSel (Just "configMonoidSkipMsys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FirstFalse) :*: (S1 (MetaSel (Just "configMonoidCompilerCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First VersionCheck)) :*: S1 (MetaSel (Just "configMonoidCompilerRepository") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First CompilerRepository)))) :*: (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 [FilePath]))) :*: (S1 (MetaSel (Just "configMonoidExtraLibDirs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [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 "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 "configMonoidCabalConfigOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (MonoidMap CabalConfigKey (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 FirstTrue))))) :*: (((S1 (MetaSel (Just "configMonoidExplicitSetupDeps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map (Maybe PackageName) Bool)) :*: (S1 (MetaSel (Just "configMonoidRebuildGhcOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FirstFalse) :*: 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 "configMonoidColorWhen") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First ColorWhen)) :*: S1 (MetaSel (Just "configMonoidStyles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StylesUpdate)) :*: (S1 (MetaSel (Just "configMonoidHideSourcePaths") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FirstTrue) :*: S1 (MetaSel (Just "configMonoidRecommendUpgrade") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FirstTrue))))))))

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 WantedCompiler)

  Compiler override

• globalTerminal :: !Bool

  We're in a terminal?

• globalStylesUpdate :: !StylesUpdate

  SGR (Ansi) codes for styles

• globalTermWidth :: !(Maybe Int)

  Terminal width override

• globalStackYaml :: !StackYamlLoc

  Override project stack.yaml

• globalLockFileBehavior :: !LockFileBehavior

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

  Whether to include timings in logs.

• globalMonoidConfigMonoid :: !ConfigMonoid

  Config monoid, for passing into loadConfig

• globalMonoidResolver :: !(First (Unresolved AbstractResolver))

  Resolver override

• globalMonoidResolverRoot :: !(First FilePath)

  root directory for resolver relative path

• globalMonoidCompiler :: !(First WantedCompiler)

  Compiler override

• globalMonoidTerminal :: !(First Bool)

  We're in a terminal?

• globalMonoidStyles :: !StylesUpdate

  Stack's output styles

• globalMonoidTermWidth :: !(First Int)

  Terminal width override

• globalMonoidStackYaml :: !(First FilePath)

  Override project stack.yaml

• globalMonoidLockFileBehavior :: !(First LockFileBehavior)

  See globalLockFileBehavior

Instances

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-2.1.1.1-IcmSiv90ky67Jq7jcJ1Q2" 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 FirstTrue) :*: (S1 (MetaSel (Just "globalMonoidConfigMonoid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ConfigMonoid) :*: S1 (MetaSel (Just "globalMonoidResolver") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First (Unresolved AbstractResolver)))))) :*: ((S1 (MetaSel (Just "globalMonoidResolverRoot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath)) :*: (S1 (MetaSel (Just "globalMonoidCompiler") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First WantedCompiler)) :*: S1 (MetaSel (Just "globalMonoidTerminal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) :*: ((S1 (MetaSel (Just "globalMonoidStyles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StylesUpdate) :*: S1 (MetaSel (Just "globalMonoidTermWidth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Int))) :*: (S1 (MetaSel (Just "globalMonoidStackYaml") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First FilePath)) :*: S1 (MetaSel (Just "globalMonoidLockFileBehavior") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First LockFileBehavior)))))))

data StackYamlLoc

Location for the project's stack.yaml file.

Constructors

SYLDefault

Use the standard parent-directory-checking logic

SYLOverride !(Path Abs File)

Use a specific stack.yaml file provided

SYLNoProject ![PackageIdentifierRevision]

Do not load up a project, just user configuration. Include the given extra dependencies with the resolver.

SYLGlobalProject

Do not look for a project configuration, and use the implicit global.

Instances

Show StackYamlLoc

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> StackYamlLoc -> ShowS

show :: StackYamlLoc -> String

showList :: [StackYamlLoc] -> ShowS

stackYamlLocL :: HasRunner env => Lens' env StackYamlLoc

data LockFileBehavior

How to interact with lock files

Constructors

LFBReadWrite

Read and write lock files

LFBReadOnly

Read lock files, but do not write them

LFBIgnore

Entirely ignore lock files

LFBErrorOnWrite

Error out on trying to write a lock file. This can be used to ensure that lock files in a repository already ensure reproducible builds.

Instances

Bounded LockFileBehavior

Defined in Stack.Types.Config

Methods

minBound :: LockFileBehavior

maxBound :: LockFileBehavior

Enum LockFileBehavior

Defined in Stack.Types.Config

Methods

succ :: LockFileBehavior -> LockFileBehavior

pred :: LockFileBehavior -> LockFileBehavior

toEnum :: Int -> LockFileBehavior

fromEnum :: LockFileBehavior -> Int

enumFrom :: LockFileBehavior -> [LockFileBehavior]

enumFromThen :: LockFileBehavior -> LockFileBehavior -> [LockFileBehavior]

enumFromTo :: LockFileBehavior -> LockFileBehavior -> [LockFileBehavior]

enumFromThenTo :: LockFileBehavior -> LockFileBehavior -> LockFileBehavior -> [LockFileBehavior]

Show LockFileBehavior

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> LockFileBehavior -> ShowS

show :: LockFileBehavior -> String

showList :: [LockFileBehavior] -> ShowS

readLockFileBehavior :: ReadM LockFileBehavior

Parser for LockFileBehavior

lockFileBehaviorL :: HasRunner env => SimpleGetter env LockFileBehavior

defaultLogLevel :: LogLevel

Default logging level should be something useful but not crazy.

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

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

• projectDependencies :: ![RawPackageLocation]

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

  How we resolve which Snapshot to use

• projectCompiler :: !(Maybe WantedCompiler)

  Override the compiler in projectResolver

• projectExtraPackageDBs :: ![FilePath]
• projectCurator :: !(Maybe Curator)

  Extra configuration intended exclusively for usage by the curator tool. In other words, this is not part of the documented and exposed Stack API. SUBJECT TO CHANGE.

• projectDropPackages :: !(Set PackageName)

  Packages to drop from the projectResolver.

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 ProjectConfig a

Project configuration information. Not every run of Stack has a true local project; see constructors below.

Constructors

PCProject a

Normal run: we want a project, and have one. This comes from either SYLDefault or SYLOverride.

PCGlobalProject

No project was found when using SYLDefault. Instead, use the implicit global.

PCNoProject ![PackageIdentifierRevision]

Use a no project run. This comes from SYLNoProject.

data Curator

Extra configuration intended exclusively for usage by the curator tool. In other words, this is not part of the documented and exposed Stack API. SUBJECT TO CHANGE.

Constructors

Curator

Fields

• curatorSkipTest :: !(Set PackageName)
• curatorExpectTestFailure :: !(Set PackageName)
• curatorSkipBenchmark :: !(Set PackageName)
• curatorExpectBenchmarkFailure :: !(Set PackageName)
• curatorSkipHaddock :: !(Set PackageName)
• curatorExpectHaddockFailure :: !(Set PackageName)

Instances

Show Curator

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> Curator -> ShowS

show :: Curator -> String

showList :: [Curator] -> ShowS

ToJSON Curator

Defined in Stack.Types.Config

Methods

toJSON :: Curator -> Value

toEncoding :: Curator -> Encoding

toJSONList :: [Curator] -> Value

toEncodingList :: [Curator] -> Encoding

FromJSON (WithJSONWarnings Curator)

Defined in Stack.Types.Config

Methods

parseJSON :: Value -> Parser (WithJSONWarnings Curator)

parseJSONList :: Value -> Parser [WithJSONWarnings Curator]

data ProjectAndConfigMonoid

Constructors

ProjectAndConfigMonoid !Project !ConfigMonoid

parseProjectAndConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings (IO 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

Styles

readStyles :: ReadM StylesUpdate

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

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 ActualCompiler

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

extraBinDirs :: HasEnvConfig env => RIO env (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 :: HasEnvConfig env => RIO env (Path Abs Dir)

Where HPC reports and tix files get stored.

installationRootDeps :: HasEnvConfig env => RIO env (Path Abs Dir)

Installation root for dependencies

installationRootLocal :: HasEnvConfig env => RIO env (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 :: HasEnvConfig env => RIO env (Path Abs Dir)

Hoogle directory.

hoogleDatabasePath :: HasEnvConfig env => RIO env (Path Abs File)

Get the hoogle database path.

packageDatabaseDeps :: HasEnvConfig env => RIO env (Path Abs Dir)

Package database for installing dependencies into

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

Extra package databases

packageDatabaseLocal :: HasEnvConfig env => RIO env (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

ExecOptsExtra

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 ActualCompiler 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 WantedCompiler

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

actualCompilerVersionL :: HasSourceMap env => SimpleGetter env ActualCompiler

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

class HasCompiler env where

An environment which ensures that the given compiler is available on the PATH

Methods

compilerPathsL :: SimpleGetter env CompilerPaths

Instances

HasCompiler CompilerPaths

Defined in Stack.Types.Config

Methods

compilerPathsL :: SimpleGetter CompilerPaths CompilerPaths

HasCompiler EnvConfig

Defined in Stack.Types.Config

Methods

compilerPathsL :: SimpleGetter EnvConfig CompilerPaths

data DumpPackage

Dump information for a single package

Constructors

DumpPackage

Fields

• dpGhcPkgId :: !GhcPkgId
• dpPackageIdent :: !PackageIdentifier
• dpParentLibIdent :: !(Maybe PackageIdentifier)
• dpLicense :: !(Maybe License)
• dpLibDirs :: ![FilePath]
• dpLibraries :: ![Text]
• dpHasExposedModules :: !Bool
• dpExposedModules :: !(Set ModuleName)
• dpDepends :: ![GhcPkgId]
• dpHaddockInterfaces :: ![FilePath]
• dpHaddockHtml :: !(Maybe FilePath)
• dpIsExposed :: !Bool

Instances

Eq DumpPackage

Defined in Stack.Types.Config

Methods

(==) :: DumpPackage -> DumpPackage -> Bool

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

Read DumpPackage

Defined in Stack.Types.Config

Methods

readsPrec :: Int -> ReadS DumpPackage

readList :: ReadS [DumpPackage]

readPrec :: ReadPrec DumpPackage

readListPrec :: ReadPrec [DumpPackage]

Show DumpPackage

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> DumpPackage -> ShowS

show :: DumpPackage -> String

showList :: [DumpPackage] -> ShowS

data CompilerPaths

Paths on the filesystem for the compiler we're using

Constructors

CompilerPaths

Fields

• cpCompilerVersion :: !ActualCompiler
• cpArch :: !Arch
• cpBuild :: !CompilerBuild
• cpCompiler :: !(Path Abs File)
• cpPkg :: !GhcPkgExe

  ghc-pkg or equivalent

• cpInterpreter :: !(Path Abs File)

  runghc

• cpHaddock :: !(Path Abs File)

  haddock, in IO to allow deferring the lookup

• cpSandboxed :: !Bool

  Is this a Stack-sandboxed installation?

• cpCabalVersion :: !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 ls dependencies | grep Cabal in the stack project.

• cpGlobalDB :: !(Path Abs Dir)

  Global package database

• cpGhcInfo :: !ByteString

  Output of ghc --info

• cpGlobalDump :: !(Map PackageName DumpPackage)

Instances

Show CompilerPaths

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> CompilerPaths -> ShowS

show :: CompilerPaths -> String

showList :: [CompilerPaths] -> ShowS

HasCompiler CompilerPaths

Defined in Stack.Types.Config

Methods

compilerPathsL :: SimpleGetter CompilerPaths CompilerPaths

newtype GhcPkgExe

Location of the ghc-pkg executable

Constructors

GhcPkgExe (Path Abs File)

Instances

Show GhcPkgExe

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> GhcPkgExe -> ShowS

show :: GhcPkgExe -> String

showList :: [GhcPkgExe] -> ShowS

getGhcPkgExe :: HasCompiler env => RIO env GhcPkgExe

Get the GhcPkgExe from a HasCompiler environment

cpWhich :: (MonadReader env m, HasCompiler env) => m WhichCompiler

data ExtraDirs

Constructors

ExtraDirs

Fields

• edBins :: ![Path Abs Dir]
• edInclude :: ![Path Abs Dir]
• edLib :: ![Path Abs Dir]

Instances

Show ExtraDirs

Defined in Stack.Types.Config

Methods

showsPrec :: Int -> ExtraDirs -> ShowS

show :: ExtraDirs -> String

showList :: [ExtraDirs] -> ShowS

Generic ExtraDirs

Defined in Stack.Types.Config

Associated Types

type Rep ExtraDirs :: Type -> Type

Methods

from :: ExtraDirs -> Rep ExtraDirs x

to :: Rep ExtraDirs x -> ExtraDirs

Semigroup ExtraDirs

Defined in Stack.Types.Config

Methods

(<>) :: ExtraDirs -> ExtraDirs -> ExtraDirs

sconcat :: NonEmpty ExtraDirs -> ExtraDirs

stimes :: Integral b => b -> ExtraDirs -> ExtraDirs

Monoid ExtraDirs

Defined in Stack.Types.Config

Methods

mempty :: ExtraDirs

mappend :: ExtraDirs -> ExtraDirs -> ExtraDirs

mconcat :: [ExtraDirs] -> ExtraDirs

type Rep ExtraDirs

Defined in Stack.Types.Config

type Rep ExtraDirs = D1 (MetaData "ExtraDirs" "Stack.Types.Config" "stack-2.1.1.1-IcmSiv90ky67Jq7jcJ1Q2" False) (C1 (MetaCons "ExtraDirs" PrefixI True) (S1 (MetaSel (Just "edBins") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Path Abs Dir]) :*: (S1 (MetaSel (Just "edInclude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Path Abs Dir]) :*: S1 (MetaSel (Just "edLib") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Path Abs Dir]))))

buildOptsL :: HasConfig s => Lens' s BuildOpts

globalOptsL :: HasRunner env => Lens' env GlobalOpts

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 :: HasConfig s => Lens' s (Path Abs Dir)

cabalVersionL :: HasCompiler env => SimpleGetter env Version

whichCompilerL :: Getting r ActualCompiler WhichCompiler

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

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