| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Stack.Types.Config
Contents
Description
The Config type.
- class HasPlatform env where
- data PlatformVariant
- data Config = Config {
- configWorkDir :: !(Path Rel Dir)
- configUserConfigPath :: !(Path Abs File)
- configBuild :: !BuildOpts
- configDocker :: !DockerOpts
- configNix :: !NixOpts
- configProcessContextSettings :: !(EnvSettings -> IO ProcessContext)
- configLocalProgramsBase :: !(Path Abs Dir)
- configLocalPrograms :: !(Path Abs Dir)
- configHideTHLoading :: !Bool
- configPlatform :: !Platform
- configPlatformVariant :: !PlatformVariant
- configGHCVariant0 :: !(Maybe GHCVariant)
- configGHCBuild :: !(Maybe CompilerBuild)
- configUrls :: !Urls
- configSystemGHC :: !Bool
- configInstallGHC :: !Bool
- configSkipGHCCheck :: !Bool
- configSkipMsys :: !Bool
- configCompilerCheck :: !VersionCheck
- configLocalBin :: !(Path Abs Dir)
- configRequireStackVersion :: !VersionRange
- configJobs :: !Int
- configOverrideGccPath :: !(Maybe (Path Abs File))
- configOverrideHpack :: !HpackExecutable
- configExtraIncludeDirs :: !(Set FilePath)
- configExtraLibDirs :: !(Set FilePath)
- configConcurrentTests :: !Bool
- configImage :: !ImageOpts
- configTemplateParams :: !(Map Text Text)
- configScmInit :: !(Maybe SCM)
- configGhcOptionsByName :: !(Map PackageName [Text])
- configGhcOptionsByCat :: !(Map ApplyGhcOptions [Text])
- configSetupInfoLocations :: ![SetupInfoLocation]
- configPvpBounds :: !PvpBounds
- configModifyCodePage :: !Bool
- configExplicitSetupDeps :: !(Map (Maybe PackageName) Bool)
- configRebuildGhcOptions :: !Bool
- configApplyGhcOptions :: !ApplyGhcOptions
- configAllowNewer :: !Bool
- configDefaultTemplate :: !(Maybe TemplateName)
- configAllowDifferentUser :: !Bool
- configDumpLogs :: !DumpLogs
- configMaybeProject :: !(Maybe (Project, Path Abs File))
- configAllowLocals :: !Bool
- configSaveHackageCreds :: !Bool
- configRunner :: !Runner
- configCabalLoader :: !CabalLoader
- class (HasPlatform env, HasProcessContext env, HasCabalLoader env) => HasConfig env where
- askLatestSnapshotUrl :: (MonadReader env m, HasConfig env) => m Text
- explicitSetupDeps :: (MonadReader env m, HasConfig env) => PackageName -> m Bool
- data BuildConfig = BuildConfig {
- bcConfig :: !Config
- bcSnapshotDef :: !SnapshotDef
- bcGHCVariant :: !GHCVariant
- bcPackages :: ![PackageLocation Subdirs]
- bcDependencies :: ![PackageLocationIndex Subdirs]
- bcExtraPackageDBs :: ![Path Abs Dir]
- bcStackYaml :: !(Path Abs File)
- bcFlags :: !(Map PackageName (Map FlagName Bool))
- bcImplicitGlobal :: !Bool
- data LocalPackages = LocalPackages {}
- data LocalPackageView = LocalPackageView {
- lpvCabalFP :: !(Path Abs File)
- lpvGPD :: !GenericPackageDescription
- lpvLoc :: !(PackageLocation FilePath)
- lpvRoot :: LocalPackageView -> Path Abs Dir
- lpvName :: LocalPackageView -> PackageName
- lpvVersion :: LocalPackageView -> Version
- lpvComponents :: LocalPackageView -> Set NamedComponent
- stackYamlL :: HasBuildConfig env => Lens' env (Path Abs File)
- projectRootL :: HasBuildConfig env => Getting r env (Path Abs Dir)
- class HasConfig env => HasBuildConfig env where
- data GHCVariant
- ghcVariantName :: GHCVariant -> String
- ghcVariantSuffix :: GHCVariant -> String
- parseGHCVariant :: MonadThrow m => String -> m GHCVariant
- class HasGHCVariant env where
- snapshotsDir :: (MonadReader env m, HasEnvConfig env, MonadThrow m) => m (Path Abs Dir)
- data EnvConfig = EnvConfig {}
- class (HasBuildConfig env, HasGHCVariant env) => HasEnvConfig env where
- getCompilerPath :: (MonadIO m, MonadThrow m, MonadReader env m, HasConfig env) => WhichCompiler -> m (Path Abs File)
- data ApplyGhcOptions
- data HpackExecutable
- data ConfigException
- = ParseConfigFileException (Path Abs File) ParseException
- | ParseCustomSnapshotException Text ParseException
- | NoProjectConfigFound (Path Abs Dir) (Maybe Text)
- | UnexpectedArchiveContents [Path Abs Dir] [Path Abs File]
- | UnableToExtractArchive Text (Path Abs File)
- | BadStackVersionException VersionRange
- | NoMatchingSnapshot WhichSolverCmd (NonEmpty SnapName)
- | ResolverMismatch WhichSolverCmd !Text String
- | ResolverPartial WhichSolverCmd !Text String
- | NoSuchDirectory FilePath
- | ParseGHCVariantException String
- | BadStackRoot (Path Abs Dir)
- | Won'tCreateStackRootInDirectoryOwnedByDifferentUser (Path Abs Dir) (Path Abs Dir)
- | UserDoesn'tOwnDirectory (Path Abs Dir)
- | FailedToCloneRepo String
- | ManualGHCVariantSettingsAreIncompatibleWithSystemGHC
- | NixRequiresSystemGhc
- | NoResolverWhenUsingNoLocalConfig
- | InvalidResolverForNoLocalConfig String
- | DuplicateLocalPackageNames ![(PackageName, [PackageLocationIndex FilePath])]
- data WhichSolverCmd
- data ConfigMonoid = ConfigMonoid {
- configMonoidStackRoot :: !(First (Path Abs Dir))
- configMonoidWorkDir :: !(First (Path Rel Dir))
- configMonoidBuildOpts :: !BuildOptsMonoid
- configMonoidDockerOpts :: !DockerOptsMonoid
- configMonoidNixOpts :: !NixOptsMonoid
- configMonoidConnectionCount :: !(First Int)
- configMonoidHideTHLoading :: !(First Bool)
- configMonoidLatestSnapshotUrl :: !(First Text)
- configMonoidUrls :: !UrlsMonoid
- configMonoidPackageIndices :: !(First [PackageIndex])
- configMonoidSystemGHC :: !(First Bool)
- configMonoidInstallGHC :: !(First Bool)
- configMonoidSkipGHCCheck :: !(First Bool)
- configMonoidSkipMsys :: !(First Bool)
- configMonoidCompilerCheck :: !(First VersionCheck)
- configMonoidRequireStackVersion :: !IntersectingVersionRange
- configMonoidArch :: !(First String)
- configMonoidGHCVariant :: !(First GHCVariant)
- configMonoidGHCBuild :: !(First CompilerBuild)
- configMonoidJobs :: !(First Int)
- configMonoidExtraIncludeDirs :: !(Set FilePath)
- configMonoidExtraLibDirs :: !(Set FilePath)
- configMonoidOverrideGccPath :: !(First (Path Abs File))
- configMonoidOverrideHpack :: !(First FilePath)
- configMonoidConcurrentTests :: !(First Bool)
- configMonoidLocalBinPath :: !(First FilePath)
- configMonoidImageOpts :: !ImageOptsMonoid
- configMonoidTemplateParameters :: !(Map Text Text)
- configMonoidScmInit :: !(First SCM)
- configMonoidGhcOptionsByName :: !(Map PackageName [Text])
- configMonoidGhcOptionsByCat :: !(Map ApplyGhcOptions [Text])
- configMonoidExtraPath :: ![Path Abs Dir]
- configMonoidSetupInfoLocations :: ![SetupInfoLocation]
- configMonoidLocalProgramsBase :: !(First (Path Abs Dir))
- configMonoidPvpBounds :: !(First PvpBounds)
- configMonoidModifyCodePage :: !(First Bool)
- configMonoidExplicitSetupDeps :: !(Map (Maybe PackageName) Bool)
- configMonoidRebuildGhcOptions :: !(First Bool)
- configMonoidApplyGhcOptions :: !(First ApplyGhcOptions)
- configMonoidAllowNewer :: !(First Bool)
- configMonoidDefaultTemplate :: !(First TemplateName)
- configMonoidAllowDifferentUser :: !(First Bool)
- configMonoidDumpLogs :: !(First DumpLogs)
- configMonoidSaveHackageCreds :: !(First Bool)
- configMonoidIgnoreRevisionMismatch :: !(First Bool)
- configMonoidInstallGHCName :: Text
- configMonoidSystemGHCName :: Text
- parseConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ConfigMonoid)
- data DumpLogs
- data EnvSettings = EnvSettings {
- esIncludeLocals :: !Bool
- esIncludeGhcPackagePath :: !Bool
- esStackExe :: !Bool
- esLocaleUtf8 :: !Bool
- esKeepGhcRts :: !Bool
- minimalEnvSettings :: EnvSettings
- defaultEnvSettings :: EnvSettings
- plainEnvSettings :: EnvSettings
- data GlobalOpts = GlobalOpts {
- globalReExecVersion :: !(Maybe String)
- globalDockerEntrypoint :: !(Maybe DockerEntrypoint)
- globalLogLevel :: !LogLevel
- globalTimeInLog :: !Bool
- globalConfigMonoid :: !ConfigMonoid
- globalResolver :: !(Maybe AbstractResolver)
- globalCompiler :: !(Maybe (CompilerVersion CVWanted))
- globalTerminal :: !Bool
- globalColorWhen :: !ColorWhen
- globalTermWidth :: !(Maybe Int)
- globalStackYaml :: !(StackYamlLoc FilePath)
- data GlobalOptsMonoid = GlobalOptsMonoid {
- globalMonoidReExecVersion :: !(First String)
- globalMonoidDockerEntrypoint :: !(First DockerEntrypoint)
- globalMonoidLogLevel :: !(First LogLevel)
- globalMonoidTimeInLog :: !(First Bool)
- globalMonoidConfigMonoid :: !ConfigMonoid
- globalMonoidResolver :: !(First AbstractResolver)
- globalMonoidCompiler :: !(First (CompilerVersion CVWanted))
- globalMonoidTerminal :: !(First Bool)
- globalMonoidColorWhen :: !(First ColorWhen)
- globalMonoidTermWidth :: !(First Int)
- globalMonoidStackYaml :: !(First FilePath)
- data StackYamlLoc filepath
- = SYLDefault
- | SYLOverride !filepath
- | SYLNoConfig !(Path Abs Dir)
- defaultLogLevel :: LogLevel
- data LoadConfig = LoadConfig {
- lcConfig :: !Config
- lcLoadBuildConfig :: !(Maybe (CompilerVersion CVWanted) -> IO BuildConfig)
- lcProjectRoot :: !(Maybe (Path Abs Dir))
- data PackageIndex = PackageIndex {
- indexName :: !IndexName
- indexLocation :: !Text
- indexType :: !IndexType
- indexDownloadPrefix :: !Text
- indexRequireHashes :: !Bool
- newtype IndexName = IndexName {}
- indexNameText :: IndexName -> Text
- data Project = Project {
- projectUserMsg :: !(Maybe String)
- projectPackages :: ![PackageLocation Subdirs]
- projectDependencies :: ![PackageLocationIndex Subdirs]
- projectFlags :: !(Map PackageName (Map FlagName Bool))
- projectResolver :: !Resolver
- projectCompiler :: !(Maybe (CompilerVersion CVWanted))
- projectExtraPackageDBs :: ![FilePath]
- data ProjectAndConfigMonoid = ProjectAndConfigMonoid !Project !ConfigMonoid
- parseProjectAndConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ProjectAndConfigMonoid)
- data PvpBounds = PvpBounds {
- pbType :: !PvpBoundsType
- pbAsRevision :: !Bool
- data PvpBoundsType
- parsePvpBounds :: Text -> Either String PvpBounds
- readColorWhen :: ReadM ColorWhen
- data SCM = Git
- bindirSuffix :: Path Rel Dir
- configInstalledCache :: (HasBuildConfig env, MonadReader env m) => m (Path Abs File)
- configLoadedSnapshotCache :: (MonadThrow m, MonadReader env m, HasConfig env, HasGHCVariant env) => SnapshotDef -> GlobalInfoSource -> m (Path Abs File)
- data GlobalInfoSource
- getProjectWorkDir :: (HasBuildConfig env, MonadReader env m) => m (Path Abs Dir)
- docDirSuffix :: Path Rel Dir
- flagCacheLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- extraBinDirs :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Bool -> [Path Abs Dir])
- hpcReportDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- installationRootDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- installationRootLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- bindirCompilerTools :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- hoogleRoot :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- hoogleDatabasePath :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs File)
- packageDatabaseDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- packageDatabaseExtra :: (MonadReader env m, HasEnvConfig env) => m [Path Abs Dir]
- packageDatabaseLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)
- platformOnlyRelDir :: (MonadReader env m, HasPlatform env, MonadThrow m) => m (Path Rel Dir)
- platformGhcRelDir :: (MonadReader env m, HasEnvConfig env, MonadThrow m) => m (Path Rel Dir)
- platformGhcVerOnlyRelDir :: (MonadReader env m, HasPlatform env, HasGHCVariant env, MonadThrow m) => m (Path Rel Dir)
- useShaPathOnWindows :: MonadThrow m => Path Rel Dir -> m (Path Rel Dir)
- 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)
- data EvalOpts = EvalOpts {
- evalArg :: !String
- evalExtra :: !ExecOptsExtra
- data ExecOpts = ExecOpts {
- eoCmd :: !SpecialExecCmd
- eoArgs :: ![String]
- eoExtra :: !ExecOptsExtra
- data SpecialExecCmd
- data ExecOptsExtra
- = ExecOptsPlain
- | ExecOptsEmbellished {
- eoEnvSettings :: !EnvSettings
- eoPackages :: ![String]
- eoRtsOptions :: ![String]
- eoCwd :: !(Maybe FilePath)
- data DownloadInfo = DownloadInfo {}
- data VersionedDownloadInfo = VersionedDownloadInfo {}
- data GHCDownloadInfo = GHCDownloadInfo {}
- data SetupInfo = SetupInfo {}
- data SetupInfoLocation
- newtype DockerEntrypoint = DockerEntrypoint {}
- data DockerUser = DockerUser {}
- wantedCompilerVersionL :: HasBuildConfig s => Getting r s (CompilerVersion CVWanted)
- actualCompilerVersionL :: HasEnvConfig s => Lens' s (CompilerVersion CVActual)
- buildOptsL :: HasConfig s => Lens' s BuildOpts
- globalOptsL :: Lens' GlobalOpts ConfigMonoid
- buildOptsInstallExesL :: Lens' BuildOpts Bool
- buildOptsMonoidHaddockL :: Lens' BuildOptsMonoid (Maybe Bool)
- buildOptsMonoidTestsL :: Lens' BuildOptsMonoid (Maybe Bool)
- buildOptsMonoidBenchmarksL :: Lens' BuildOptsMonoid (Maybe Bool)
- buildOptsMonoidInstallExesL :: Lens' BuildOptsMonoid (Maybe Bool)
- buildOptsHaddockL :: Lens' BuildOpts Bool
- globalOptsBuildOptsMonoidL :: Lens' GlobalOpts BuildOptsMonoid
- stackRootL :: HasCabalLoader s => Lens' s (Path Abs Dir)
- configUrlsL :: HasConfig env => Lens' env Urls
- cabalVersionL :: HasEnvConfig env => Lens' env Version
- whichCompilerL :: Getting r (CompilerVersion a) WhichCompiler
- envOverrideSettingsL :: HasConfig env => Lens' env (EnvSettings -> IO ProcessContext)
- loadedSnapshotL :: HasEnvConfig env => Lens' env LoadedSnapshot
- globalHintsL :: HasBuildConfig s => Getting r s (Map PackageName (Maybe Version))
- shouldForceGhcColorFlag :: (HasRunner env, HasEnvConfig env) => RIO env Bool
- appropriateGhcColorFlag :: (HasRunner env, HasEnvConfig env) => RIO env (Maybe String)
- view :: MonadReader s m => Getting a s a -> m a
- to :: (s -> a) -> SimpleGetter s a
Main configuration types and classes
HasPlatform & HasStackRoot
class HasPlatform env where Source #
Class for environment values which have a Platform
data PlatformVariant Source #
A variant of the platform, used to differentiate Docker builds from host
Constructors
| PlatformVariantNone | |
| PlatformVariant String |
Instances
Config & HasConfig
The top-level Stackage configuration.
Constructors
| Config | |
Fields
| |
class (HasPlatform env, HasProcessContext env, HasCabalLoader env) => HasConfig env where Source #
Class for environment values that can provide a Config.
askLatestSnapshotUrl :: (MonadReader env m, HasConfig env) => m Text Source #
Get the URL to request the information on the latest snapshots
explicitSetupDeps :: (MonadReader env m, HasConfig env) => PackageName -> m Bool Source #
Provide an explicit list of package dependencies when running a custom Setup.hs
BuildConfig & HasBuildConfig
data BuildConfig Source #
A superset of Config adding information on how to build code. The reason
for this breakdown is because we will need some of the information from
Config in order to determine the values here.
These are the components which know nothing about local configuration.
Constructors
| BuildConfig | |
Fields
| |
data LocalPackages Source #
Constructors
| LocalPackages | |
Fields | |
data LocalPackageView Source #
A view of a local package needed for resolving components
Constructors
| LocalPackageView | |
Fields
| |
lpvRoot :: LocalPackageView -> Path Abs Dir Source #
Root directory for the given LocalPackageView
lpvName :: LocalPackageView -> PackageName Source #
Package name for the given 'LocalPackageView
lpvVersion :: LocalPackageView -> Version Source #
Version for the given 'LocalPackageView
lpvComponents :: LocalPackageView -> Set NamedComponent Source #
All components available in the given LocalPackageView
stackYamlL :: HasBuildConfig env => Lens' env (Path Abs File) Source #
projectRootL :: HasBuildConfig env => Getting r env (Path Abs Dir) Source #
Directory containing the project's stack.yaml file
class HasConfig env => HasBuildConfig env where Source #
Methods
buildConfigL :: Lens' env BuildConfig Source #
buildConfigL :: HasEnvConfig env => Lens' env BuildConfig Source #
Instances
GHCVariant & HasGHCVariant
data GHCVariant Source #
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
ghcVariantName :: GHCVariant -> String Source #
Render a GHC variant to a String.
ghcVariantSuffix :: GHCVariant -> String Source #
Render a GHC variant to a String suffix.
parseGHCVariant :: MonadThrow m => String -> m GHCVariant Source #
Parse GHC variant from a String.
class HasGHCVariant env where Source #
Class for environment values which have a GHCVariant
Methods
ghcVariantL :: Lens' env GHCVariant Source #
ghcVariantL :: HasBuildConfig env => Lens' env GHCVariant Source #
snapshotsDir :: (MonadReader env m, HasEnvConfig env, MonadThrow m) => m (Path Abs Dir) Source #
Directory containing snapshots
EnvConfig & HasEnvConfig
Configuration after the environment has been setup.
Constructors
| EnvConfig | |
Fields
| |
class (HasBuildConfig env, HasGHCVariant env) => HasEnvConfig env where Source #
Minimal complete definition
Methods
envConfigL :: Lens' env EnvConfig Source #
Instances
getCompilerPath :: (MonadIO m, MonadThrow m, MonadReader env m, HasConfig env) => WhichCompiler -> m (Path Abs File) Source #
Get the path for the given compiler ignoring any local binaries.
Details
ApplyGhcOptions
data ApplyGhcOptions Source #
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 |
ConfigException
data HpackExecutable Source #
Constructors
| HpackBundled | |
| HpackCommand String |
data ConfigException Source #
Constructors
Instances
WhichSolverCmd
data WhichSolverCmd Source #
Constructors
| IsInitCmd | |
| IsSolverCmd | |
| IsNewCmd |
ConfigMonoid
data ConfigMonoid Source #
Constructors
Instances
parseConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ConfigMonoid) Source #
DumpLogs
Which build log files to dump
Constructors
| DumpNoLogs | don't dump any logfiles |
| DumpWarningLogs | dump logfiles containing warnings |
| DumpAllLogs | dump all logfiles |
EnvSettings
data EnvSettings Source #
Controls which version of the environment is used
Constructors
| EnvSettings | |
Fields
| |
Instances
defaultEnvSettings :: EnvSettings Source #
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 Source #
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 Source #
Parsed global command-line options.
Constructors
| GlobalOpts | |
Fields
| |
Instances
data GlobalOptsMonoid Source #
Parsed global command-line options monoid.
Constructors
| GlobalOptsMonoid | |
Fields
| |
data StackYamlLoc filepath Source #
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 Source # | |
| Foldable StackYamlLoc Source # | |
| Traversable StackYamlLoc Source # | |
| Show filepath => Show (StackYamlLoc filepath) Source # | |
defaultLogLevel :: LogLevel Source #
Default logging level should be something useful but not crazy.
LoadConfig
data LoadConfig Source #
Value returned by loadConfig.
Constructors
| LoadConfig | |
Fields
| |
PackageIndex, IndexName & IndexLocation
data PackageIndex Source #
Information on a single package index
Constructors
| PackageIndex | |
Fields
| |
Instances
Unique name for a package index
Constructors
| IndexName | |
Fields | |
indexNameText :: IndexName -> Text Source #
Project & ProjectAndConfigMonoid
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
| |
data ProjectAndConfigMonoid Source #
Constructors
| ProjectAndConfigMonoid !Project !ConfigMonoid |
parseProjectAndConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ProjectAndConfigMonoid) Source #
PvpBounds
Constructors
| PvpBounds | |
Fields
| |
data PvpBoundsType Source #
How PVP bounds should be added to .cabal files
Constructors
| PvpBoundsNone | |
| PvpBoundsUpper | |
| PvpBoundsLower | |
| PvpBoundsBoth |
ColorWhen
SCM
A software control system.
Constructors
| Git |
Paths
configInstalledCache :: (HasBuildConfig env, MonadReader env m) => m (Path Abs File) Source #
File containing the installed cache, see Stack.PackageDump
configLoadedSnapshotCache :: (MonadThrow m, MonadReader env m, HasConfig env, HasGHCVariant env) => SnapshotDef -> GlobalInfoSource -> m (Path Abs File) Source #
Where to store LoadedSnapshot caches
data GlobalInfoSource Source #
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) Source #
Per-project work dir
flagCacheLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Directory for holding flag cache information
extraBinDirs :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Bool -> [Path Abs Dir]) Source #
Get the extra bin directories (for the PATH). Puts more local first
Bool indicates whether or not to include the locals
hpcReportDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Where HPC reports and tix files get stored.
installationRootDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Installation root for dependencies
installationRootLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Installation root for locals
bindirCompilerTools :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Installation root for compiler tools
hoogleRoot :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Hoogle directory.
hoogleDatabasePath :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs File) Source #
Get the hoogle database path.
packageDatabaseDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Package database for installing dependencies into
packageDatabaseExtra :: (MonadReader env m, HasEnvConfig env) => m [Path Abs Dir] Source #
Extra package databases
packageDatabaseLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir) Source #
Package database for installing local packages into
platformOnlyRelDir :: (MonadReader env m, HasPlatform env, MonadThrow m) => m (Path Rel Dir) Source #
Relative directory for the platform identifier
platformGhcRelDir :: (MonadReader env m, HasEnvConfig env, MonadThrow m) => m (Path Rel Dir) Source #
Relative directory for the platform and GHC identifier
platformGhcVerOnlyRelDir :: (MonadReader env m, HasPlatform env, HasGHCVariant env, MonadThrow m) => m (Path Rel Dir) Source #
Relative directory for the platform and GHC identifier without GHC bindist build
useShaPathOnWindows :: MonadThrow m => Path Rel Dir -> m (Path Rel Dir) Source #
This is an attempt to shorten stack paths on Windows to decrease our chances of hitting 260 symbol path limit. The idea is to calculate SHA1 hash of the path used on other architectures, encode with base 16 and take first 8 symbols of it.
shaPathForBytes :: (IsPath Rel t, MonadThrow m) => ByteString -> m (Path Rel t) Source #
Command-specific types
Eval
Constructors
| EvalOpts | |
Fields
| |
Exec
Constructors
| ExecOpts | |
Fields
| |
data ExecOptsExtra Source #
Constructors
| ExecOptsPlain | |
| ExecOptsEmbellished | |
Fields
| |
Instances
Setup
data DownloadInfo Source #
Build of the compiler distribution (e.g. standard, gmp4, tinfo6) | Information for a file to download.
Constructors
| DownloadInfo | |
Fields
| |
Instances
data VersionedDownloadInfo Source #
Constructors
| VersionedDownloadInfo | |
Fields | |
Constructors
| SetupInfo | |
Fields | |
data SetupInfoLocation Source #
Remote or inline SetupInfo
Constructors
| SetupInfoFileOrURL String | |
| SetupInfoInline SetupInfo |
Instances
Docker entrypoint
newtype DockerEntrypoint Source #
Data passed into Docker container for the Docker entrypoint's use
Constructors
| DockerEntrypoint | |
Fields
| |
Instances
Lens helpers
wantedCompilerVersionL :: HasBuildConfig s => Getting r s (CompilerVersion CVWanted) Source #
The compiler specified by the SnapshotDef. This may be
different from the actual compiler used!
actualCompilerVersionL :: HasEnvConfig s => Lens' s (CompilerVersion CVActual) Source #
The version of the compiler which will actually be used. May be
different than that specified in the SnapshotDef and returned
by wantedCompilerVersionL.
stackRootL :: HasCabalLoader s => Lens' s (Path Abs Dir) Source #
cabalVersionL :: HasEnvConfig env => Lens' env Version Source #
whichCompilerL :: Getting r (CompilerVersion a) WhichCompiler Source #
envOverrideSettingsL :: HasConfig env => Lens' env (EnvSettings -> IO ProcessContext) Source #
loadedSnapshotL :: HasEnvConfig env => Lens' env LoadedSnapshot Source #
globalHintsL :: HasBuildConfig s => Getting r s (Map PackageName (Maybe Version)) Source #
shouldForceGhcColorFlag :: (HasRunner env, HasEnvConfig env) => RIO env Bool Source #
appropriateGhcColorFlag :: (HasRunner env, HasEnvConfig env) => RIO env (Maybe String) Source #
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^.tof = 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